NgDocSearchPaletteTexts · API

The texts of the search palette (NgDocCommandPaletteComponent), which the navbar search opens.

DeclarationTypeScript

export interface NgDocSearchPaletteTexts { … }

Members

Properties 45
actionCopyLink: `string`	The action that copies the page link. Default: "Copy link to this page".
actionCopyLinkKeywords: `string`	Words, separated by spaces, that find the copy action. Default: "copy link url share".
actionKeepsOpen: `string`	Preview of an action that keeps the palette open. Default: "Changes the setting and keeps the search open.".
actionRunsImmediately: `string`	Preview of an action that closes the palette. Default: "Runs immediately.".
actionShortcutsKeywords: `string`	Words, separated by spaces, that find the shortcuts action. Default: "keyboard shortcuts keys single".
actionShortcutsOff: `string`	The action that turns single-key shortcuts off. Default: "Turn off single-key shortcuts".
actionShortcutsOn: `string`	The action that turns single-key shortcuts on. Default: "Turn on single-key shortcuts".
actionToggleTheme: `string`	The action that switches the theme. Default: "Toggle dark mode".
actionToggleThemeKeywords: `string`	Words, separated by spaces, that find the theme action. Default: "theme dark light mode".
dialogLabel: `string`	Accessible name of the palette dialog. Default: "Search".
failed: `string`	Shown when the search fails. Default: "Search failed. Try again.".
failedStatus: `string`	Announced when the search fails. Default: "Search failed.".
footerNavigate: `string`	Footer hint of the arrow keys. Default: "navigate".
footerScopes: `string`	Footer hint of the Tab key. Default: "scopes and settings".
footerSlash: `string`	Footer hint of the slash key. Default: "also opens search".
inputLabel: `string`	Accessible name of the search field. Default: "Search the documentation".
inputPlaceholder: `string`	Placeholder of the search field. Default: "Search guides, API and actions…".
keyEscape: `string`	The Escape key, which closes the palette. Default: "Esc".
keyTab: `string`	The Tab key, in the footer. Default: "Tab".
noResults: `(params: { query: string; }) => string`	Shown when nothing matches the query. Default: "No results for “{query}”". Values: `query`, the query.
open: `string`	Hint of the Enter key, in the preview and the footer. Default: "open".
openSymbolPage: `string`	Hint of the Enter key on an API result. Default: "open symbol page".
resultsLabel: `string`	Accessible name of the result list. Default: "Results".
scopeActions: `string`	The scope of the actions. Default: "Actions".
scopeAll: `string`	The scope with every result. Default: "All".
scopeApi: `string`	The scope of the API pages. Default: "API".
scopeGuides: `string`	The scope of the guides. Default: "Guides".
scopesLabel: `string`	Accessible name of the scope tabs. Default: "Search scope".
searching: `string`	Shown and announced while the search runs. Default: "Searching…".
sectionActions: `string`	Section of the actions. Default: "Actions".
sectionApi: `string`	Section of the API pages. Default: "API".
sectionGuides: `string`	Section of the guides. Default: "Guides".
sectionTopMatches: `string`	Section of the declarations whose name starts with the query. Default: "Top matches".
shortcut: `string`	Label of the keys of an action in the preview. Default: "Shortcut".
shortcutsSwitch: `string`	The switch for single-key shortcuts. Default: "Single-key shortcuts".
shortcutsSwitchTitle: `string`	Tooltip of the switch. Default: "Single-character shortcuts: / [ ] F L T".
statusNoResults: `(params: { scope: string; query: string; }) => string`	Announced when the search finds nothing. Default: "{scope} scope: no results for “{query}”.". Values: `scope`, the name of the selected scope; `query`, the query.
statusResults: `(params: { scope: string; count: number; }) => string`	Announced when the search finds results. Default: "{scope} scope: {count} result(s).". Values: `scope`, the name of the selected scope; `count`, the number of results.
statusScope: `(params: { scope: string; }) => string`	Announced when the query is empty. Default: "{scope} scope.". Values: `scope`, the name of the selected scope.
typeAction: `string`	Label of an action in the preview. Default: "Action".
typeApi: `string`	Chip of an API result in the preview. Default: "API".
typeGuide: `string`	Chip of a guide result in the preview. Default: "Guide".
typeToSearch: `string`	Shown before the reader types, in the All and Actions scopes. Default: "Type to search.".
typeToSearchApi: `string`	Shown before the reader types, in the API scope. Default: "Type to search the API.".
typeToSearchGuides: `string`	Shown before the reader types, in the Guides scope. Default: "Type to search the guides.".

Members

Properties