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

    Interface ImageUploadFieldComponentOptions

    interface ImageUploadFieldComponentOptions {
        "aria-label"?: string | ChildArray;
        className?: string;
        disabled?: boolean;
        help?: Children;
        helperText?: Children;
        icon?: Children;
        label?: Children;
        loading?: boolean;
        name: string;
        routePath: string;
        type: "image-upload";
        url?: string | (() => string | null) | null;
        value?: string | (() => string | null) | null;
        [property: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [property: string]: any

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

    Index

    Properties

    aria-label? className? disabled? help? helperText? icon? label? loading? name routePath type url? value?

    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.

    className?: string

    The class name(s) for this virtual element, as a space-separated list.

    disabled?: boolean

    Disables button from user input.

    Default: false

    help?: Children
    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.

    label?: Children
    loading?: boolean

    Show a loading spinner within the button.

    If true, also disables the button.

    Default: false

    name: string
    routePath: string
    type: "image-upload"

    Button type.

    Default: "button"

    https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type

    url?: string | (() => string | null) | null
    value?: string | (() => string | null) | null

    Settings

    Member Visibility

    On This Page

    Properties