Class AutocompleteDropdown<CustomAttrs>Abstract

A reusable component that wraps around an input element and displays a list of suggestions based on the input's value. Must be extended and the suggestions method implemented.

Type Parameters

Hierarchy

Constructors

constructor

Properties

attrs element hasFocus index navigator state updateMaxHeightHandler?

Methods

$ getCurrentNumericIndex getItem inputElement onbeforeremove onbeforeupdate oncreate oninit onremove onupdate selectSuggestion selectableItems setIndex suggestions updateMaxHeight view component initAttrs

Constructors

constructor

Properties

attrs

attrs: CustomAttrs

The attributes passed into the component.

See

https://mithril.js.org/components.html#passing-data-to-components

element

element: Element

The root DOM element for the component.

Protected hasFocus

hasFocus: boolean = false

Whether the input has focus.

Protected index

index: number = 0

The index of the currently-selected

  • in the results list. This can be a unique string (to account for the fact that an item's position may jump around as new results load), but otherwise it will be numeric (the sequential position within the list).

    • Protected navigator

    navigator: KeyboardNavigatable

    state

    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    Private Optional updateMaxHeightHandler

    updateMaxHeightHandler?: (() => void)

    Type declaration

      • (): void

      • Returns void

    Methods

    $

    • $(selector?): JQuery<HTMLElement>

    • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

      For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

      Parameters

      • Optional selector: string

        a jQuery-compatible selector string

      Returns JQuery<HTMLElement>

      the jQuery object for the DOM node

      Final

    getCurrentNumericIndex

    getItem

    • Get the

    • in the search results with the given index (numeric or named).

    Parameters

    Returns JQuery<HTMLElement>

    inputElement

    onbeforeremove

    onbeforeupdate

    oncreate

    oninit

    onremove

    onupdate

    selectSuggestion

    selectableItems

    setIndex

    Abstract suggestions

    updateMaxHeight

    view

    Static component

    Static initAttrs

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc v0.24.8