NgDocNavbarComponent

Navbar of the NgDoc application: the header bar above the sidebar and the page.

It lays out, from left to right: the menu button (only where the sidebar is an overlay), the content marked with ngDocNavbarLeft (for example the logo), the content marked with ngDocNavbarCenter (for example the section links, hidden at 1024px and below), the search, and the content marked with ngDocNavbarRight (for example the theme toggle).

Decorators: @Component
Selectors: ng-doc-navbar

DeclarationTypeScript

@Component({ … })
export class NgDocNavbarComponent { … }

Members

Properties 4
glassEffect: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Use glass effect for navbar
hamburger: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Show the menu button that opens the sidebar where it is an overlay (900px and below).
search: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Show search input
sidebarService: `NgDocSidebarService` protectedreadonly	—
Methods 1
(): `void` protected	Closes the sidebar overlay and moves focus back to the menu button that opened it.
Signature `protected closeSidebar(): void;` Returns `void`

Example usage

<ng-doc-navbar>
  <a ngDocNavbarLeft routerLink="/">My library</a>
  <nav ngDocNavbarCenter aria-label="Primary"><a routerLink="/docs">Guides</a></nav>
  <ng-doc-theme-toggle ngDocNavbarRight />
</ng-doc-navbar>

Members

Properties

Methods

Example usage