Flarum (v2.0.0-beta.5)
    Preparing search index...
    interface IButtonAttrs {
        "aria-label"?: string | ChildArray;
        disabled?: boolean;
        helperText?: Children;
        icon?: Children;
        loading?: boolean;
        type?: string;
        [property: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [property: string]: any

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

    Index

    Properties

    "aria-label"?: string | ChildArray

    Accessible text for the button. This should always be present if the button only contains an icon.

    The textual content of this attribute is passed to the DOM element as aria-label.

    disabled?: boolean

    Disables button from user input.

    Default: false

    helperText?: Children

    Helper text. Displayed under the button label.

    Default: null

    icon?: Children

    Class(es) of an optional icon to be rendered within the button.

    If provided, the button will gain a has-icon class.

    You may also provide a rendered icon element directly.

    loading?: boolean

    Show a loading spinner within the button.

    If true, also disables the button.

    Default: false

    type?: string

    Button type.

    Default: "button"