mithril-materialized
    Preparing search index...

    Interface MaterialBoxAttrs

    interface MaterialBoxAttrs {
        alt?: string;
        caption?: string;
        class?: string;
        className?: string;
        height?: number;
        inDuration?: number;
        key?: string | number;
        onCloseEnd?: () => void;
        onCloseStart?: () => void;
        onOpenEnd?: () => void;
        onOpenStart?: () => void;
        outDuration?: number;
        src: string;
        width?: 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 (View Summary)

    Indexable

    • [property: string]: any

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

    Index

    Properties

    alt? caption? class? className? height? inDuration? key? onCloseEnd? onCloseStart? onOpenEnd? onOpenStart? outDuration? src width?

    Methods

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

    Properties

    alt?: string

    Alt text for the image

    caption?: string

    Caption for the image overlay

    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.

    height?: number

    Height of the image

    undefined
    inDuration?: number

    Animation duration in ms

    key?: string | number

    A key to optionally associate with this element.

    onCloseEnd?: () => void

    Callback when materialbox closing animation is complete

    onCloseStart?: () => void

    Callback when materialbox is closed

    onOpenEnd?: () => void

    Callback when materialbox opening animation is complete

    onOpenStart?: () => void

    Callback when materialbox is opened

    outDuration?: number

    Animation duration in ms for closing

    src: string

    Source image path

    width?: number

    Width of the image

    undefined

    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