NgDocTitleContext · API

The parts of the current route that provideNgDocTitle passes to its function.

Outside the documentation (a landing page, for example), categories is empty and page, tab and api are not set.

DeclarationTypeScript

export interface NgDocTitleContext { … }

Members

Properties 6
api: `string \| undefined` readonly	Name of the API declaration, on an API page.
categories: `readonly string[]` readonly	Titles of the categories that contain the page, the outermost category first.
page: `string \| undefined` readonly	Title of the guide or the API list. A title in the page's own route replaces it. Not set on an API page, which sets `api` instead.
snapshot: `RouterStateSnapshot` readonly	The router state the title is for.
tab: `string \| undefined` readonly	Title of the active tab, when the page has more than one tab. Not set on a tab titled like the page, usually its first one.
title: `string \| undefined` readonly	The title Angular sets by default: the title of the deepest route that has one. It is not set when no route of the navigation has a title.