NgDocPageWrapperComponent

Layout of a generated page: the breadcrumbs, the page header, the tabs of a page with several routes, the page itself, the previous and next page links, and the table of contents beside it.

The breadcrumbs, the page links and the table of contents are the page skeleton's components, created in the containers this component exposes.

While the page shows one of its fullscreen routes (NgDocFullscreenRouteService), only the page is shown.

Decorators: @Component
Selectors: ng-doc-page-wrapper
Implements: OnInit

DeclarationTypeScript

@Component({ … })
export class NgDocPageWrapperComponent implements OnInit { … }

Members

Properties 13
context: `NgDocContext` protected	—
fullscreenRoute: `NgDocFullscreenRouteService` protectedreadonly	—
hasBreadcrumb: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Whether the page shows breadcrumbs.
headerContent: `InputSignal<string>` readonly `input()`required	HTML of the page header.
headerContentSource: `InputSignal<NgDocContentSource \| undefined>` readonly `input()`	Deferred source of the page header, for generated pages that load it separately.
pageBreadcrumbs: `Signal<ViewContainerRef>` readonly	Container of the breadcrumbs.
pageNavigation: `Signal<ViewContainerRef>` readonly	Container of the previous and next page links.
pageToc: `Signal<ViewContainerRef>` readonly	Container of the table of contents.
pageType: `InputSignal<NgDocPageType>` readonly `input()`	Type of the page: guides get previous and next page links, API pages do not.
route: `ActivatedRoute` protected	—
router: `Router` protected	—
routes: `InputSignal<Routes>` readonly `input()`required	Routes of the page; a page with more than one gets tabs.
skeleton: `NgDocPageSkeleton` protected	—
Methods 1
(): `void` implements `OnInit`	—
Signature `ngOnInit(): void;` Returns `void`

Members

Properties

Methods