NgDocSearchComponent

The search button of the navbar. It opens the search palette on click, with Command+K (Control+K) and, while single-key shortcuts are on, with the slash key. Wide screens show a search field with the key hint; narrow screens show an icon button.

Decorators: @Component
Selectors: ng-doc-search

DeclarationTypeScript

@Component({ … })
export class NgDocSearchComponent { … }

Members

Constructor

()

—

Signature

constructor(
	
): NgDocSearchComponent;

Properties

chord: WritableSignal<string>

protectedreadonly

The chord that opens the search, as the reader's platform labels it.

dialog: NgDocDialogService

protectedreadonly

—

searchEngine: NgDocSearchEngine | null

protectedreadonly

—

shortcuts: NgDocShortcutsService

protectedreadonly

—

Methods

(…): void

Opens the search palette. Focus returns to the element that had it when the palette closes.

Signature

open(query: string = ''): void;

Parameters

Name	Type	Description
query	`string`	The text the search field starts with.

Returns

void

Symbol

Kind: Class
Decorators: @Component
Selectors: ng-doc-search
Scope: @ng-doc/app

Edit this page