Class Autocomplete

A widget that provides a drop-down list of autocompletion options.

Index

Constructors

Accessors

element implementation

Methods

activate commit dismiss select activateListeners

Constructors

constructor

new Autocomplete(options?: { onSelect?: AutocompleteCallback }): Autocomplete
Parameters
- Optionaloptions: { onSelect?: AutocompleteCallback } = {}
  - OptionalonSelect?: AutocompleteCallback
    Callback to fire when an entry is selected.
Returns Autocomplete

Accessors

element

get element(): HTMLMenuElement
The auto-complete menu.

Returns HTMLMenuElement

`Static`implementation

get implementation(): typeof Autocomplete
Retrieve the configured Autocomplete implementation.

Returns typeof Autocomplete

Methods

activate

activate(
    target: HTMLElement,
    entries: AutocompleteEntry[],
    options?: { position?: any; prefix?: string },
): void
Activate an auto-complete menu.
Parameters
- target: HTMLElement
  The element the autocomplete is being rendered for.
- entries: AutocompleteEntry[]
  The entries to render.
- Optionaloptions: { position?: any; prefix?: string } = {}
  - Optionalposition?: any
    Position the menu. If omitted, the menu is positioned underneath the target.
  - Optionalprefix?: string
    The matched prefix that triggered the autocomplete menu.
Returns void

commit

commit(): void
Commit a choice.

Returns void

dismiss

dismiss(): void
Dismiss the auto-complete menu.

Returns void

select

select(increment?: number): void
Move the current auto-complete selection.
Parameters
- increment: number = 0
  The number of entries to advance the selection. A negative number moves up, and a positive number moves down.
Returns void

`Static`activateListeners

activateListeners(document: Document): void
Bind global autocomplete listeners to a given document.
Parameters
- document: Document
  The document.
Returns void