NgDocPageComponent
A generated page: its rendered content, the page actions (copy link, edit and view the source), the table of contents it fills in, and the outlet of its fullscreen routes.
A fullscreen route (a child route of the page, unless the page sets disableFullscreenRoutes) replaces the page: it is shown on its own on the canvas of demos, with a link back to the page, and
- Decorators
@Component - Selectors
ng-doc-page
@Component ({ … })
export class NgDocPageComponent { … }Members
Constructor1 | |||||||
() | — | ||||||
Signature | |||||||
Properties9 | |||||||
changeDetectorRef: | — | ||||||
contentController: | — | ||||||
fullscreenRoute: | Whether one of the page's fullscreen routes is shown instead of the page. | ||||||
linkCopied: | Whether the link to the page was just copied. | ||||||
pageContainer: | The element that holds the rendered page content. | ||||||
pageUrl: | URL of the page, for the link back from a fullscreen route. | ||||||
pageWrapper: | — | ||||||
rootPage: | — | ||||||
skeleton: | — | ||||||
Methods3 | |||||||
(): void | Copies the link to the page, without its query and fragment. | ||||||
Signature Returns void | |||||||
(): void | Creates the table of contents from the headings of the rendered page. | ||||||
Signature Returns void | |||||||
(…): void | Shows one of the page's fullscreen routes instead of the page, or the page again. The outlet of the fullscreen routes calls it when a route opens or closes. | ||||||
Signature Parameters
Returns void | |||||||