NgDocApiListTexts · API

The texts of the API list (NgDocApiListComponent).

DeclarationTypeScript

export interface NgDocApiListTexts { … }

Members

Properties 16
allKinds: `string`	The kind filter that shows every kind. Default: "All".
empty: `string`	Shown when nothing matches the filters. Default: "No declarations match.".
failed: `string`	Shown when the list did not load. Default: "The API list could not be loaded.".
filterLabel: `string`	Accessible name of the filter. Default: "Filter declarations by name".
filterLabelWithDescriptions: `string`	Accessible name of the filter when declarations have descriptions. Default: "Filter declarations by name or description".
filterPlaceholder: `string`	Placeholder of the filter. Default: "Filter by name".
filterPlaceholderWithDescriptions: `string`	Placeholder of the filter when declarations have descriptions. Default: "Filter by name or description".
groupBy: `string`	Label of the grouping buttons. Default: "Group by".
groupByKind: `string`	Groups by declaration kind. Default: "Kind".
groupByScope: `string`	Groups by scope. Default: "Scope".
kindsLabel: `string`	Accessible name of the kind filter. Default: "Filter by kind".
noDescription: `string`	A declaration without a description. Default: "No description".
scopeNote: `(params: { scope: string; }) => string`	The note of a selected scope. Default: "Showing {scope} only.". Values: `scope`, the name of the scope.
showEveryScope: `string`	The button that clears the scope. Default: "Show every scope".
summary: `(params: { declarations: number; scopes: number; }) => string`	The summary under the title. Default: "{declarations} declarations in {scopes} scope(s).". Values: `declarations` and `scopes`, the number of declarations and scopes.
title: `string`	Title of the list, unless its `title` input sets one. Default: "API References".

Members

Properties