Skip to content
@ng-doc/app / Class

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.

While it is shown, the router scrolls anchors below the navbar (the scroll offset of ViewportScroller), and the keyboard shortcuts of the documentation work (NgDocShortcutsService). When it is destroyed, for example when the reader leaves documentation served under a route, the previous scroll offset comes back and the shortcuts stop. Without navbar content, it renders no header.

Decorators
@Component
Selectors
ng-doc-root
DeclarationTypeScript
@Component({ … })
export class NgDocRootComponent { … }

Members

Constructor

1
()
—

Properties

6
footerContent: InputSignal<NgDocContent>
readonly input()

Content for footer

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

sidebarService: NgDocSidebarService
protectedreadonly
—
protectedreadonly
—

Accessors

1
get sidenav: NgDocSidenavComponent | undefined

The sidenav that holds the sidebar and the page.

Methods

1
(…): void

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

Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-root
Scope
@ng-doc/app
Edit this page