mithril-materialized
    Preparing search index...

    Interface WizardAttrs

    interface WizardAttrs {
        allowHeaderNavigation?: boolean;
        class?: string;
        className?: string;
        currentStep?: number;
        key?: string | number;
        labels?: {
            complete?: string;
            next?: string;
            optional?: string;
            previous?: string;
            skip?: string;
        };
        linear?: boolean;
        onComplete?: () => void;
        onStepChange?: (stepIndex: number, stepId: string) => void;
        orientation?: "vertical" | "horizontal";
        showNavigation?: boolean;
        showStepNumbers?: boolean;
        steps: WizardStep[];
        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
      • WizardAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    allowHeaderNavigation? class? className? currentStep? key? labels? linear? onComplete? onStepChange? orientation? showNavigation? showStepNumbers? steps

    Methods

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

    Properties

    allowHeaderNavigation?: boolean

    Whether to allow clicking on step headers to navigate

    class?: string

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

    className?: string

    Custom class for the wizard container

    currentStep?: number

    Current active step index

    key?: string | number

    A key to optionally associate with this element.

    labels?: {
        complete?: string;
        next?: string;
        optional?: string;
        previous?: string;
        skip?: string;
    }

    Custom labels for navigation buttons

    linear?: boolean

    Whether navigation is linear (cannot skip steps)

    onComplete?: () => void

    Callback when wizard is completed

    onStepChange?: (stepIndex: number, stepId: string) => void

    Callback when step changes

    orientation?: "vertical" | "horizontal"

    Orientation of the stepper

    showNavigation?: boolean

    Whether to show navigation buttons

    showStepNumbers?: boolean

    Whether to show step numbers

    steps: WizardStep[]

    Array of wizard steps

    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