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 (), 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 ), and the keyboard shortcuts of the documentation work (). 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
@Component ({ … })
export class NgDocRootComponent { … }Members
Constructor1 | |||||||
() | — | ||||||
Signature | |||||||
Properties6 | |||||||
footerContent: | Content for footer | ||||||
fullscreenRoute: | — | ||||||
noWidthLimit: | If | ||||||
sidebar: | If | ||||||
sidebarService: | — | ||||||
texts: | — | ||||||
Accessors1 | |||||||
get sidenav: | The sidenav that holds the sidebar and the page. | ||||||
Methods1 | |||||||
(…): void | Moves keyboard focus to the page content, as the skip link does. | ||||||
Signature Parameters
Returns void | |||||||