NgDocListComponent

Keyboard navigation for the options inside it: arrow keys move the active option and Enter selects it. The keys also work from the list host's origin (for example a combobox input).

Decorators: @Component
Selectors: ng-doc-list

DeclarationTypeScript

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

Members

Constructor

()

—

Signature

constructor(
	
): NgDocListComponent;

Methods

(…): void

Adds an item to the keyboard navigation.

Signature

registerItem(item: NgDocListItem): void;

Parameters

Name	Type	Description
item	`NgDocListItem`	The item to add.

Returns

void

(…): void

Removes an item from the keyboard navigation.

Signature

unregisterItem(item: NgDocListItem): void;

Parameters

Name	Type	Description
item	`NgDocListItem`	The item to remove.

Returns

void

Symbol

Kind: Class
Decorators: @Component
Selectors: ng-doc-list
Scope: @ng-doc/ui-kit

Edit this page