Skip to content
@ng-doc/ui-kit / Class

NgDocSidenavComponent

Layout with a side panel next to the projected content.

At 900px and below the side panel becomes an overlay that slides in from the left; opened shows it and closeEvent asks the owner to hide it. The panel has the id ng-doc-sidenav, so a toggle button can point aria-controls at it.

Decorators
@Component
Selectors
ng-doc-sidenav
DeclarationTypeScript
@Component({ … })
export class NgDocSidenavComponent { … }

Members

Properties

4
closeEvent: OutputEmitterRef<void>
readonly output()

Emits when the backdrop is clicked, so the owner can close the sidenav.

hasBackdrop: InputSignalWithTransform<boolean, unknown>
readonly input()

Indicates whether the sidenav has a backdrop or not.

opened: InputSignalWithTransform<boolean, unknown>
readonly input()

Indicates whether the sidenav is opened or not. This is used to trigger the animation.

Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-sidenav
Scope
@ng-doc/ui-kit
Edit this page