mithril-materialized
    Preparing search index...

    Interface CarouselAttrs

    interface CarouselAttrs {
        class?: string;
        className?: string;
        dist?: number;
        duration?: number;
        fullWidth?: boolean;
        indicators?: boolean;
        items: CarouselItem[];
        key?: string | number;
        noWrap?: boolean;
        numVisible?: number;
        onCycleTo?: (item: CarouselItem, index: number, dragged: boolean) => void;
        padding?: number;
        shift?: 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

    class? className? dist? duration? fullWidth? indicators? items key? noWrap? numVisible? onCycleTo? padding? shift?

    Methods

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

    Properties

    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.

    dist?: number

    Zoom scale (perspective distance)

    duration?: number

    Duration of carousel item change animation in ms

    fullWidth?: boolean

    Change to full width styles

    indicators?: boolean

    Toggle indicators

    items: CarouselItem[]

    The list of images

    key?: string | number

    A key to optionally associate with this element.

    noWrap?: boolean

    Don't wrap around and cycle through items

    numVisible?: number

    Number of visible items in carousel

    onCycleTo?: (item: CarouselItem, index: number, dragged: boolean) => void

    Called when carousel item changes

    padding?: number

    Padding between non-center items

    shift?: number

    Spacing for center image

    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