mithril-materialized
    Preparing search index...

    Interface ModalAttrs

    interface ModalAttrs {
        bottomSheet?: boolean;
        buttons?: {
            className?: string;
            disabled?: boolean;
            iconName?: string;
            label: string;
            onclick?: (e: UIEvent) => void;
        }[];
        class?: string;
        className?: string;
        closeOnBackdropClick?: boolean;
        closeOnEsc?: boolean;
        description?: string
        | Vnode<any, any>;
        fixedFooter?: boolean;
        id?: string;
        isOpen?: boolean;
        key?: string | number;
        onClose?: () => void;
        onToggle?: (open: boolean) => void;
        richContent?: boolean;
        showCloseButton?: boolean;
        title: string;
        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
      • ModalAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    bottomSheet? buttons? class? className? closeOnBackdropClick? closeOnEsc? description? fixedFooter? id? isOpen? key? onClose? onToggle? richContent? showCloseButton? title

    Methods

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

    Properties

    bottomSheet?: boolean

    Display on the bottom

    buttons?: {
        className?: string;
        disabled?: boolean;
        iconName?: string;
        label: string;
        onclick?: (e: UIEvent) => void;
    }[]

    Menu buttons, from left to right

    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.

    closeOnBackdropClick?: boolean

    Close modal when clicking backdrop

    closeOnEsc?: boolean

    Close modal when pressing escape key

    description?: string | Vnode<any, any>
    fixedFooter?: boolean

    Fixate the footer, so you can show more content.

    id?: string
    isOpen?: boolean

    Control modal visibility externally

    key?: string | number

    A key to optionally associate with this element.

    onClose?: () => void

    Called when modal is closed

    onToggle?: (open: boolean) => void

    Called when modal should be opened/closed

    richContent?: boolean

    Set to true when the description contains HTML

    showCloseButton?: boolean

    Show close button in top right

    title: string

    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