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

    Class Dropdown<CustomAttrs>

    The Dropdown component displays a button which, when clicked, shows a dropdown menu beneath it.

    The children will be displayed as a list inside the dropdown menu.

    Type Parameters

    Hierarchy (View Summary)

    Index

    The attributes passed into the component.

    closeWatcher?: CloseWatcher
    element: Element

    The root DOM element for the component.

    showing: boolean = false
    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.

    • 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

    • The accessible name of the toggle button.

      It starts with the visible label, so that the name contains the text the button displays (WCAG 2.5.3, Label in Name), followed by the description of what the button does. Speech-input users can then activate the button by saying what they see on it.

      Parameters

      • children: ChildArray

      Returns string | undefined