mithril-materialized
    Preparing search index...

    Interface RadioButtonsAttrs<T>

    interface RadioButtonsAttrs<T extends string | number> {
        checkboxClass?: string;
        checkedId?: T;
        class?: string;
        className?: string;
        defaultCheckedId?: T;
        description?: string;
        disabled?: boolean;
        id?: string;
        isMandatory?: boolean;
        key?: string | number;
        label?: string;
        layout?: "vertical" | "horizontal";
        newRow?: boolean;
        onchange?: (id: T) => void;
        options: InputOption<T>[];
        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;
    }

    Type Parameters

    • T extends string | number

    Hierarchy

    • Attributes
      • RadioButtonsAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    checkboxClass? checkedId? class? className? defaultCheckedId? description? disabled? id? isMandatory? key? label? layout? newRow? onchange? options

    Methods

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

    Properties

    checkboxClass?: string

    Optional CSS that is added to the input checkbox, e.g. if you add col s4, the items will be put inline

    checkedId?: T

    Currently selected id for controlled mode. If provided along with onchange, the component operates in controlled mode where the parent manages the state. The parent must update this value in response to onchange callbacks.

    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.

    defaultCheckedId?: T

    Default selected id for uncontrolled mode. Only used when checkedId and onchange are not provided. The component will manage its own internal state in uncontrolled mode.

    description?: string

    Optional description

    disabled?: boolean

    Disable the button

    id?: string

    Element ID

    isMandatory?: boolean

    If true, add a mandatory '*' after the label

    key?: string | number

    A key to optionally associate with this element.

    label?: string

    Optional title or label

    layout?: "vertical" | "horizontal"

    Layout for the options: 'vertical' (default) or 'horizontal'

    newRow?: boolean

    If true, start on a new row

    onchange?: (id: T) => void

    Event handler that is called when an option is changed. Optional for uncontrolled mode.

    options: InputOption<T>[]

    The options that you have

    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