@types/wallop

Installation

npm install --save @types/wallop

Summary

This package contains type definitions for wallop (https://github.com/peduarte/wallop).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wallop.

index.d.ts

export = Wallop;
export as namespace Wallop;

declare namespace Wallop {
    interface Options {
        /**
         * Override class for "next" button.
         *
         * @default 'Wallop-buttonNext'
         */
        buttonNextClass?: string | undefined;

        /**
         * Override class for "previous" button.
         *
         * @default 'Wallop-buttonPrevious'
         */
        buttonPreviousClass?: string | undefined;

        /**
         * Enable/disable carousel mode.
         *
         * @default true
         */
        carousel?: boolean | undefined;

        /**
         * Override class for current item.
         *
         * @default 'Wallop-item--current'
         */
        currentItemClass?: string | undefined;

        /**
         * Override class that hides next item.
         *
         * @default 'Wallop-item--hideNext'
         */
        hideNextClass?: string | undefined;

        /**
         * Override class that hides previous item.
         *
         * @default 'Wallop-item--hidePrevious'
         */
        hidePreviousClass?: string | undefined;

        /**
         * Override class for item.
         *
         * @default 'Wallop-item'
         */
        itemClass?: string | undefined;

        /**
         * Override class for item that will show next.
         *
         * @default 'Wallop-item--showNext'
         */
        showNextClass?: string | undefined;

        /**
         * Override class for item that will showed previously.
         *
         * @default 'Wallop-item--showPrevious'
         */
        showPreviousClass?: string | undefined;
    }
}

declare class Wallop {
    /**
     * Implement new instance of Wallop.
     */
    constructor(selector: Element, options?: Wallop.Options);

    /**
     * Advances to the slide with the given index.
     */
    goTo(index: number): Wallop;

    /**
     * Advances to next slide.
     */
    next(): Wallop;

    /**
     * Unbinds method from custom event.
     */
    off(eventName: string, callback: () => void): Wallop;

    /**
     * Bind method to custom event.
     */
    on(eventName: string, callback: () => void): Wallop;

    /**
     * Returns to previous slide.
     */
    previous(): Wallop;

    /**
     * Resets current Wallop instance to defaults.
     */
    reset(): Wallop;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Nathanael McDaniel.