Class SearchModal<CustomAttrs>

The FormModal component displays a modal dialog, wrapped in a form. Subclasses should implement the className, title, and content methods.

Type Parameters

Hierarchy

Constructors

Properties

activeSource: Stream<SearchSource>

The key of the currently-active search source.

alertAttrs: null | AlertAttrs = null

Attributes for an alert component to show below the header.

attrs: CustomAttrs

The attributes passed into the component.

element: Element

The root DOM element for the component.

gambitsAutocomplete: Record<string, GambitsAutocomplete> = {}
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).

  • inputScroll: Stream<number> = ...
    loading: boolean = false
    loadingSources: string[] = []

    The sources that are still loading results.

    query: Stream<string>
    searchState: SearchState
    searchTimeout?: number
    sources: SearchSource[]

    An array of SearchSources.

    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.

    LIMIT: number = 6
    isDismissibleViaBackdropClick: boolean = true

    Can the modal be dismissed via a click on the backdrop.

    isDismissibleViaCloseButton: boolean = true

    Can the model be dismissed with a close button (X)?

    If false, no close button is shown.

    isDismissibleViaEscKey: boolean = true

    Can the modal be dismissed by pressing the Esc key on a keyboard?

    Accessors

    Methods

    • 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

    • Get the

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

    Parameters

    Returns JQuery<HTMLElement>

    Generated using TypeDoc v0.24.8