mithril-materialized
    Preparing search index...

    Interface CircularProgressAttrs

    CircularProgress component attributes

    interface CircularProgressAttrs {
        "aria-label"?: string;
        "aria-valuemax"?: number;
        "aria-valuemin"?: number;
        "aria-valuenow"?: number;
        "aria-valuetext"?: string;
        class?: string;
        className?: string;
        color?: MaterialColor;
        colorIntensity?: ColorIntensity;
        id?: string;
        key?: string | number;
        label?: string | number;
        max?: number;
        mode?: ProgressMode;
        showPercentage?: boolean;
        size?: ProgressSize;
        style?: any;
        value?: number;
        onbeforeremove?(this: any, vnode: VnodeDOM<any, any>): void | Promise<any>;
        onbeforeupdate?(
            this: any,
            vnode: Vnode<any, any>,
            old: VnodeDOM<any, any>,
        ): boolean | void;
        oncreate?(this: any, vnode: VnodeDOM<any, any>): any;
        oninit?(this: any, vnode: Vnode<any, any>): any;
        onremove?(this: any, vnode: VnodeDOM<any, any>): any;
        onupdate?(this: any, vnode: VnodeDOM<any, any>): any;
        [property: string]: any;
    }

    Hierarchy

    • Attributes
      • CircularProgressAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    aria-label? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? class? className? color? colorIntensity? id? key? label? max? mode? showPercentage? size? style? value?

    Methods

    onbeforeremove? onbeforeupdate? oncreate? oninit? onremove? onupdate?

    Properties

    "aria-label"?: string

    ARIA label for accessibility

    "aria-valuemax"?: number

    ARIA valuemax (default: 100)

    "aria-valuemin"?: number

    ARIA valuemin (default: 0)

    "aria-valuenow"?: number

    ARIA valuenow (current value)

    "aria-valuetext"?: string

    ARIA valuetext (custom text description)

    class?: string

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

    className?: string

    Additional CSS class names

    color?: MaterialColor

    Materialize color (default: 'teal')

    colorIntensity?: ColorIntensity

    Color intensity modifier

    id?: string

    HTML ID for the component

    key?: string | number

    A key to optionally associate with this element.

    label?: string | number

    Label to display inside the circle

    max?: number

    Maximum progress value (default: 100)

    mode?: ProgressMode

    Progress mode (default: 'indeterminate')

    showPercentage?: boolean

    Auto-show percentage inside circle for determinate mode (default: false)

    size?: ProgressSize

    Size variant (default: 'medium')

    style?: any

    Additional CSS styles

    value?: number

    Current progress value (0-100) for determinate mode

    Methods

    • The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns void | Promise<any>

    • The onbeforeupdate hook is called before a vnode is diffed in a update.

      Parameters

      • this: any
      • vnode: Vnode<any, any>
      • old: VnodeDOM<any, any>

      Returns boolean | void

    • The oncreate hook is called after a DOM element is created and attached to the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    • The oninit hook is called before a vnode is touched by the virtual DOM engine.

      Parameters

      • this: any
      • vnode: Vnode<any, any>

      Returns any

    • The onremove hook is called before a DOM element is removed from the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    • The onupdate hook is called after a DOM element is updated, while attached to the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods