NgDocRootComponent

Root layout of the NgDoc application: the navbar, the sidebar, the page and the footer.

Its first focusable element is a "Skip to content" link, shown only while it has focus, that moves keyboard focus past the navbar and the sidebar to the page.

While a page shows one of its fullscreen routes (NgDocFullscreenRouteService), only the page is shown: the navbar, the sidebar, the footer and the skip link are hidden.

Decorators: @Component
Selectors: ng-doc-root

DeclarationTypeScript

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

Members

Properties

footerContent: InputSignal<NgDocContent>

readonly input()

Content for footer

fullscreenRoute: NgDocFullscreenRouteService

protectedreadonly

—

noWidthLimit: InputSignalWithTransform<boolean, unknown>

readonly input()

If true then page will be shown without width limit. You can use it for example for landing page

sidebar: InputSignalWithTransform<boolean, unknown>

readonly input()

If true then the sidebar will be shown You can use it for example for landing page to hide sidebar

sidebarService: NgDocSidebarService

protectedreadonly

—

Accessors

get sidenav: NgDocSidenavComponent | undefined

The sidenav that holds the sidebar and the page.

Methods

(…): void

Moves keyboard focus to the page content, as the skip link does.

Signature

skipToContent(event?: Event | undefined): void;

Parameters

Name	Type	Description
event	`Event \| undefined`	The click on the skip link; its navigation to a fragment is cancelled.

Returns

void