Overview
Selector
[qzSidebar]
| Input |
Type |
Default |
Required |
Description |
mode |
SidebarMode | null |
null |
|
|
desktopMode |
SidebarMode |
DEFAULT_SIDEBAR_CONFIG.desktopMode |
|
|
mobileMode |
SidebarMode |
DEFAULT_SIDEBAR_CONFIG.mobileMode |
|
|
breakpoint |
SidebarBreakpoint |
DEFAULT_SIDEBAR_CONFIG.breakpoint |
|
|
side |
SidebarSide |
DEFAULT_SIDEBAR_CONFIG.side |
|
|
scrollLock |
unknown |
DEFAULT_SIDEBAR_CONFIG.scrollLock |
|
Transform booleanAttribute; reads as boolean. |
focusMode |
SidebarFocusMode |
DEFAULT_SIDEBAR_CONFIG.focusMode |
|
|
autoCloseOnMobile |
unknown |
DEFAULT_SIDEBAR_CONFIG.autoCloseOnMobile |
|
Transform booleanAttribute; reads as boolean. |
Models
Two-way bindings: each model is an input and emits the matching change output.
| Model |
Type |
Default |
Required |
Change output |
Description |
open |
boolean |
true |
|
openChange |
|
collapsed |
boolean |
false |
|
collapsedChange |
|
Properties
| Name |
Type |
Description |
readonly isDesktop |
Signal<boolean> |
|
readonly currentMode |
Signal<SidebarMode> |
|
readonly state |
Signal<SidebarState> |
|
readonly panelId |
Signal<string> |
|
readonly isOverlayOpen |
Signal<boolean> |
|
readonly gridTemplateColumns |
Signal<string> |
|
Public methods
registerPanel
registerPanel(panel: SidebarPanelDirective): void
unregisterPanel
unregisterPanel(panel: SidebarPanelDirective): void
registerTrigger
registerTrigger(trigger: SidebarTriggerDirective): void
unregisterTrigger
unregisterTrigger(trigger: SidebarTriggerDirective): void
toggle
toggle(): void
close
close(): void
expand
expand(): void
collapse
collapse(): void
handlePanelKeydown
handlePanelKeydown(event: KeyboardEvent): void
| Parameter |
Type |
Optional |
Description |
event |
KeyboardEvent |
|
|