SiSidePanelService documentation¶
provided in root
✓
Attributes and Methods¶
| Name | Type | Default | Description |
|---|---|---|---|
| close() ¶ | () => void | Close side panel. | |
| hideTemporaryContent() ¶ | () => boolean | Hide side panel temporary content, reverting to state before showing temporary content. | |
| isFullscreen() ¶ | () => boolean | Indicate if side panel is in fullscreen overlay mode. | |
| (readonly) isFullscreen$ ¶ | Observable<boolean> | ... | Emits when fullscreen overlay mode is toggled. |
| isOpen() ¶ | () => boolean | Indicate is side panel open. | |
| (readonly) isOpen$ ¶ | Observable<boolean> | this.openSubject.asObservable() | Emits on side panel is open or close. |
| isTemporaryOpen() ¶ | () => boolean | Indicate that the side panel is open with temporary content. | |
| open() ¶ | () => void | Open side panel. | |
| releaseBodyScrollLock() ¶ | () => void | Release body scroll lock. Restores scroll when no more locks exist. | |
| requestBodyScrollLock() ¶ | () => void | Request body scroll lock. Uses reference counting to handle multiple panels. | |
| setFullscreen(...) ¶ | (fullscreen: boolean) => void | Set fullscreen overlay mode. Parameters
| |
| setSidePanelContent(...) ¶ | (portal: (Portal<any> | undefined)) => void | Set or update displayed content. Parameters | |
| showTemporaryContent(...) ¶ | (portal: (Portal<any> | undefined)) => Observable<void> | Show side panel temporary content, opening the side panel when necessary. Parameters | |
| toggle() ¶ | () => void | Toggle side panel open/close. | |
| toggleFullscreen() ¶ | () => void | Toggle fullscreen overlay mode. |
Types Documentation¶
No types to document for items on this page.
Except where otherwise noted, content on this site is licensed under MIT License.