mithril-materialized
    Preparing search index...

    Interface DropdownAttrs<T>

    interface DropdownAttrs<T extends string | number> {
        checkedId?: T;
        class?: string;
        className?: string;
        defaultCheckedId?: T;
        disabled?: boolean;
        helperText?: string;
        iconName?: string;
        id?: T;
        items: DropdownItem<T>[];
        key?: string | number;
        label?: string;
        onchange?: (value: T) => void;
        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
      • DropdownAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    checkedId? class? className? defaultCheckedId? disabled? helperText? iconName? id? items key? label? onchange?

    Methods

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

    Properties

    checkedId?: T

    Currently selected item 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 item id for uncontrolled mode. Only used when checkedId and onchange are not provided. The component will manage its own internal state in uncontrolled mode.

    disabled?: boolean

    If true, disable the selection

    helperText?: string

    Add a description underneath the input field.

    iconName?: string

    Uses Materialize icons as a prefix or postfix.

    id?: T

    Optional id of the dropdown element

    'dropdown'
    items: DropdownItem<T>[]

    Item array to show in the dropdown. If the value is not supplied, uses he name.

    key?: string | number

    A key to optionally associate with this element.

    label?: string

    Optional label when no item is selected

    'Select'
    onchange?: (value: T) => void

    When a value or name is selected. Optional for uncontrolled 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