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

    Interface IHeaderDropdownAttrs

    interface IHeaderDropdownAttrs {
        accessibleToggleLabel?: string;
        buttonAttrs?: Record<string, string>;
        buttonClassName?: string;
        caretIcon?: string;
        icon?: string;
        label: Children;
        lazyDraw?: boolean;
        menuClassName?: string;
        onhide?: () => void;
        onshow?: () => void;
        state: any;
        tooltip?: string;
        [property: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [property: string]: any

      Any other virtual element properties, including attributes and event handlers.

    Index

    Properties

    accessibleToggleLabel? buttonAttrs? buttonClassName? caretIcon? icon? label lazyDraw? menuClassName? onhide? onshow? state tooltip?

    Properties

    accessibleToggleLabel?: string

    The label used to describe the dropdown toggle button to assistive readers. Defaults to 'Toggle dropdown menu'.

    buttonAttrs?: Record<string, string>

    Additional attributes to apply to the dropdown toggle button.

    buttonClassName?: string

    A class name to apply to the dropdown toggle button.

    caretIcon?: string

    The name of an icon to show on the right of the button.

    icon?: string

    The name of an icon to show in the dropdown toggle button.

    label: Children

    The label of the dropdown toggle button. Defaults to 'Controls'.

    lazyDraw?: boolean
    menuClassName?: string

    A class name to apply to the dropdown menu.

    onhide?: () => void

    An action to take when the dropdown is collapsed.

    onshow?: () => void

    An action to take when the dropdown is opened.

    state: any
    tooltip?: string

    An optional tooltip to show when hovering over the dropdown toggle button.

    Settings

    Member Visibility

    On This Page

    Properties