NgDocSelectionHostDirective

Tracks which of its ngDocSelectionOrigin elements is selected, so that an ng-doc-selection inside it can highlight that element.

DeclarationTypeScript

@Directive({ … })
export class NgDocSelectionHostDirective { … }

Members

selected: Signal<HTMLElement | undefined>

readonly

Element of the selected origin, or undefined when none is selected.

(…): void

Updates the selection after an origin changed its state or went away.

Signature

changeSelected(origin: NgDocSelectionOriginDirective, selected: boolean): void;

Parameters

Name	Type	Description
origin	`NgDocSelectionOriginDirective`	The origin whose state changed.
selected	`boolean`	Whether the origin is selected now.

Returns

void

(…): void

Selects an element that cannot carry ngDocSelectionOrigin, because Angular does not render it: for example a tab in the HTML of a generated page.

Signature

select(element: HTMLElement | undefined): void;

Parameters

Name	Type	Description
element	`HTMLElement \| undefined`	The element to highlight, or `undefined` to highlight none.

Returns

void

Symbol