Flarum (2.x)
    Preparing search index...

    Class IconPicker<CustomAttrs>

    A searchable grid of the Font Awesome icons the forum can draw, in solid, regular and brands styles. See IconInput, which pairs it with a text field that still accepts any class.

    Type Parameters

    Hierarchy (View Summary)

    Index

    The attributes passed into the component.

    closeWatcher?: CloseWatcher
    element: Element

    The root DOM element for the component.

    loaded: Map<string, FontAwesomeIcon[]> = ...

    The icons of each style shown so far, by its class.

    query: string = ''
    reading: boolean = false

    Whether the forum's stylesheets are still being fetched to read them.

    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.

    styles: FontAwesomeStyle[] = []
    • 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

    • Pick for Enter: an icon named exactly, then a typed class nothing matches, then the closest match. Worked out from the search as it is now, as Enter can come before the redraw that follows typing, such as after a paste.

      Returns void