import { KbqSidepanelModule } from '@koobiq/components/sidepanel';| Name | Description |
|---|---|
| openedSidepanels: KbqSidepanelRef |
Keeps track of the currently-open sidepanels. |
Button that will close the current sidepanel.
Selector: button[kbq-sidepanel-close], button[kbqSidepanelClose]
| Name | Description |
|---|---|
@Input() kbqSidepanelClose: any
|
|
@Input('kbq-sidepanel-close')
sidepanelResult: any
|
|
| sidepanelRef: KbqSidepanelRef |
Selector: kbq-sidepanel-container
| Name | Description |
|---|---|
| animationState: KbqSidepanelAnimationState | The state of the sidepanel animations. |
| animationStateChanged: EventEmitter |
Emits whenever the state of the animation changes. |
| attachDomPortal: (portal: DomPortal |
|
| id: string | ID for the container DOM element. |
| portalOutlet: CdkPortalOutlet | The portal outlet inside of this container into which the content will be loaded. |
| sidepanelConfig: KbqSidepanelConfig |
|
| withIndent: boolean |
Header of a sidepanel.
Selector: kbq-sidepanel-header
| Name | Description |
|---|---|
@Input() closeable: boolean
|
Add button for close sidepanel. Default false |
@Input() truncateText: boolean
|
Enables text truncation. Default true |
Scrollable content container of a sidepanel.
Selector: kbq-sidepanel-body, [kbq-sidepanel-body], kbqSidepanelBody
Footer of a sidepanel.
Selector: kbq-sidepanel-footer, [kbq-sidepanel-footer], kbqSidepanelFooter
Actions block of a sidepanel footer.
Selector: kbq-sidepanel-actions, [kbq-sidepanel-actions], kbqSidepanelActions
| Name | Description |
|---|---|
| backdropClass: string | |
| data: D | Data being injected into the child component. |
| disableClose: boolean | Whether the user can use escape or clicking outside to close the sidepanel. |
| hasBackdrop: boolean | Whether the sidepanel has a backdrop. |
| id: string | ID for the sidepanel. If omitted, a unique one will be generated. |
| injector: Injector | Injector used for the instantiation of the component to be attached. Allows to pass a custom injector to provide a dependency injection hierarchy for the sidepanel content. |
| overlayPanelClass: string | string[] | Custom class for the overlay pane. |
| position: KbqSidepanelPosition | |
| size: KbqSidepanelSize | |
| trapFocus: boolean | Whether the focus trap is active. |
| trapFocusAutoCapture: boolean | capture focus on initialization. This option sets cdkTrapFocusAutoCapture. |
Deprecated requiredBackdrop: boolean
|
When we open multiple sidepanels, backdrop appears only once, except cases then this flag is true. |
| Name | Description |
|---|---|
| bodyOverflow: WritableSignal<{ top: boolean; bottom: boolean; }> | Vertical scroll overflow state of the sidepanel body. Updated on scroll and used for visual adjustments. |
| config: KbqSidepanelConfig |
|
| containerInstance: KbqSidepanelContainerComponent | |
| id: string | |
| instance: T | Instance of the component making up the content of the sidepanel. |
| overlayRef: OverlayRef |
Injection token that can be used to access the data that was passed in to a sidepanel.
const KBQ_SIDEPANEL_DATA: InjectionToken<any>;
Injection token that can be used to specify default sidepanel options.
const KBQ_SIDEPANEL_DEFAULT_OPTIONS: InjectionToken<KbqSidepanelConfig<any>>;
const KBQ_SIDEPANEL_WITH_INDENT: InjectionToken<boolean>;
const KBQ_SIDEPANEL_WITH_SHADOW: InjectionToken<boolean>;