Skip to content

PopoverSuggest

Base class for adding a type-ahead popover.

Extends

Extended by

Type Parameters

T

Implements

Constructors

new PopoverSuggest()

new PopoverSuggest<T>(app, scope?): PopoverSuggest<T>

Parameters

app: App

scope?: Scope

Returns

PopoverSuggest<T>

Properties

app

app: App


isOpen

isOpen: boolean

Whether the suggestion popup is currently open and visible


scope

scope: Scope


suggestEl

suggestEl: HTMLElement

Suggestion container element


suggestions

suggestions: SuggestionContainer<T>

Handles selection and rendering of the suggestions

Methods

close()

close(): void

Returns

void

Implementation of

CloseableComponent.close

Inherited from

CloseableComponent.close


open()

open(): void

Returns

void


renderSuggestion()

abstract renderSuggestion(value, el): void

Render the suggestion item into DOM.

Parameters

value: T

el: HTMLElement

Returns

void

Implementation of

ISuggestOwner.renderSuggestion

Inherited from

ISuggestOwner.renderSuggestion


selectSuggestion()

abstract selectSuggestion(value, evt): void

Called when the user makes a selection.

Parameters

value: T

evt: MouseEvent | KeyboardEvent

Returns

void

Implementation of

ISuggestOwner.selectSuggestion

Inherited from

ISuggestOwner.selectSuggestion