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

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

    Index

    Constructors

    constructor

    Properties

    activeSource alertAttrs attrs element gambitsAutocomplete index inputScroll loading loadingSources navigator query searchState searchTimeout? sources state isDismissibleViaBackdropClick isDismissibleViaCloseButton isDismissibleViaEscKey LIMIT

    Accessors

    dismissibleOptions dismissibleOptions

    Methods

    $ activeTabItems className clear content defaultActiveSource defaultFilters gambifyInput gambits getCurrentNumericIndex getItem hide inner inputElement loaded onbeforeremove onbeforeupdate oncreate onerror oninit onready onremove onsubmit onupdate prefill search selectableItems selectResult setIndex switchSource tabItems tabs title view wrapper component initAttrs

    Constructors

    Properties

    activeSource: Stream<GlobalSearchSource>

    The key of the currently-active search source.

    alertAttrs: AlertAttrs | null = null

    Attributes for an alert component to show below the header.

    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.

    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.

    navigator: KeyboardNavigatable
    query: Stream<string>
    searchState: SearchState
    searchTimeout?: number
    sources: GlobalSearchSource[]

    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.

    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?

    LIMIT: number = 6

    Accessors

    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

    content

    • Get the

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

    Parameters

    Returns JQuery

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods