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

    The Search component displays a primary search input at the top of the frontend (forum or admin). When clicked, it opens an advanced search modal with results from various sources.

    Must be extended and the abstract methods implemented per-frontend.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    searchState: SearchState

    The instance of SearchState for this component.

    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

    • 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