Flarum (v2.0.0-beta.5)
    Preparing search index...

    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 (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs element hasFocus index navigator state

    Methods

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

    Constructors

    Properties

    attrs: CustomAttrs

    The attributes passed into the component.

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

    element: Element

    The root DOM element for the component.

    hasFocus: boolean = false

    Whether the input has focus.

    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).

    • navigator: KeyboardNavigatable
    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.

    Methods

    $

    • $(selector?: string): JQuery

      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

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    • Get the

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

    Parameters

    Returns JQuery

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods