mithril-materialized
    Preparing search index...

    Interface ToggleGroupAttrs

    Attributes for the ToggleGroup component.

    A toggle group is a container for multiple toggle buttons that manages their selection state. It can operate in single-select or multi-select mode.

    interface ToggleGroupAttrs {
        class?: string;
        className?: string;
        defaultValue?: string | number | (string | number)[];
        disabled?: boolean;
        items: ToggleButtonAttrs[];
        key?: string | number;
        multiple?: boolean;
        onchange?: (value: string | number | (string | number)[]) => void;
        value?: string | number | (string | 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
      • ToggleGroupAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    class? className? defaultValue? disabled? items key? multiple? onchange? value?

    Methods

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

    Properties

    class?: string

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

    className?: string

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

    defaultValue?: string | number | (string | number)[]

    The default value(s) for uncontrolled mode. Use this when you want the component to manage its own state.

    disabled?: boolean

    Whether all buttons in the group are disabled.

    items: ToggleButtonAttrs[]

    Array of button configurations to display in the group. Each item can have its own icon, label, tooltip, and disabled state.

    key?: string | number

    A key to optionally associate with this element.

    multiple?: boolean

    Whether to allow multiple buttons to be selected simultaneously.

    • false (default): only one button can be selected at a time
    • true: multiple buttons can be selected
    onchange?: (value: string | number | (string | number)[]) => void

    Callback invoked when the selection changes.

    Type Declaration

      • (value: string | number | (string | number)[]): void

      • Parameters

        • value: string | number | (string | number)[]

          The new value (single value or array depending on multiple)

        Returns void

    value?: string | number | (string | number)[]

    The current value(s) of the toggle group (controlled mode).

    • Single-select: a single value
    • Multi-select: an array of values

    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