mithril-materialized
    Preparing search index...

    Interface SidenavAttrs

    interface SidenavAttrs {
        animationDuration?: number;
        breakpoint?: number;
        class?: string;
        className?: string;
        closeOnBackdropClick?: boolean;
        closeOnEscape?: boolean;
        fixed?: boolean;
        id?: string;
        isOpen?: boolean;
        key?: string | number;
        mode?: "push" | "overlay";
        onToggle?: (isOpen: boolean) => void;
        position?: "left" | "right";
        showBackdrop?: boolean;
        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

    • Attributes
      • SidenavAttrs

    Indexable

    • [property: string]: any

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

    Index

    Properties

    animationDuration? breakpoint? class? className? closeOnBackdropClick? closeOnEscape? fixed? id? isOpen? key? mode? onToggle? position? showBackdrop? width?

    Methods

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

    Properties

    animationDuration?: number

    Animation duration in milliseconds

    breakpoint?: number

    Breakpoint for responsive behavior (in pixels)

    class?: string

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

    className?: string

    Custom class for the sidenav

    closeOnBackdropClick?: boolean

    Close sidenav when backdrop is clicked

    closeOnEscape?: boolean

    Close sidenav when escape key is pressed

    fixed?: boolean

    Fixed sidenav (always visible on larger screens)

    id?: string

    Unique ID for the sidenav

    isOpen?: boolean

    Whether the sidenav is open

    key?: string | number

    A key to optionally associate with this element.

    mode?: "push" | "overlay"

    Whether sidenav should overlay content or push it

    onToggle?: (isOpen: boolean) => void

    Callback when sidenav open state changes

    position?: "left" | "right"

    Position of the sidenav

    showBackdrop?: boolean

    Whether to show backdrop overlay

    width?: number

    Width of the sidenav in pixels

    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