import { KbqSidepanelModule } from '@koobiq/components/sidepanel';
Properties
Name Description
openedSidepanels: KbqSidepanelRef[] Keeps track of the currently-open sidepanels.
Methods
closeAll
Closes all of the currently-open sidepanels.
getSidepanelById
Finds an open sidepanel by its id.
open

Button that will close the current sidepanel.

Selector: button[kbq-sidepanel-close], button[kbqSidepanelClose]

Properties
Name Description
@Input()
kbqSidepanelClose: any
@Input('kbq-sidepanel-close')
sidepanelResult: any
sidepanelRef: KbqSidepanelRef

Selector: kbq-sidepanel-container

Properties
Name Description
animationState: KbqSidepanelAnimationState The state of the sidepanel animations.
animationStateChanged: EventEmitter Emits whenever the state of the animation changes.
attachDomPortal: (portal: DomPortal) => any
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
Methods
attach
attachComponentPortal
Attach a component portal as content to this sidepanel container.
attachTemplatePortal
Attach a template portal as content to this sidepanel container.
detach
Detaches a previously attached portal.
dispose
Permanently dispose of this portal host.
enter
Begin animation of the sidepanel entrance into view.
exit
Begin animation of the sidepanel exiting from view.
hasAttached
Whether this host has an attached portal.

Header of a sidepanel.

Selector: kbq-sidepanel-header

Properties
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

Properties
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.
Properties
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
Methods
afterClosed
Gets an observable that is notified when the sidepanel is finished closing.
afterOpened
Gets an observable that is notified when the sidepanel has opened and appeared.
beforeClosed
Gets an observable that is notified when the sidepanel is started closing.
close

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>;
Deprecated
const KBQ_SIDEPANEL_WITH_SHADOW: InjectionToken<boolean>;
Docs Feedback
If you have any questions or would like to contribute to writing the documentation, please create an issue in our GitHub repository.