@types/rellax/index.d.ts

TypeScript definitions for rellax

declare namespace Rellax {
    interface Rellax {
        /**
         * Inits and starts the Parallax animations
         * @param el Single element or string with selector of elements
         * @param options Options
         */
        (el?: string | Element, options?: RellaxOptions): RellaxInstance;
        /**
         * Inits and starts the Parallax animations
         * @param el Single element or string with selector of elements
         * @param options Options
         */
        new(el?: string | Element, options?: RellaxOptions): RellaxInstance;
    }

    interface RellaxInstance {
        /**
         * End Rellax and reset parallax elements to their original positions
         */
        destroy(): void;
        /**
         * Rellax elements
         */
        elms: NodeListOf<Element> | Element[];
        /**
         * Options
         */
        options: RellaxOptions;
        /**
         * Destroy and create again parallax with previous settings
         */
        refresh(): void;
    }

    interface RellaxOptions {
        /**
         * Will run on every animation event
         * @param positions Object with x and y positions of the rellax element
         */
        callback?(positions: { x: number; y: number }): void;
        /**
         * Enable the ability to center parallax elements in your viewport
         */
        center?: boolean | undefined;
        /**
         * Enable horizontal parallax. This feature is intended for panoramic style websites, where users scroll horizontally instead of vertically
         */
        horizontal?: boolean | undefined;
        /**
         * Allow decimal pixel values
         */
        round?: boolean | undefined;
        /**
         * A negative value will make it move slower than regular scrolling, and a positive value will make it move faster
         */
        speed?: number | undefined;
        /**
         * Enable vertical parallax
         */
        vertical?: boolean | undefined;
        /**
         * By default, the position of parallax elements is determined via the scroll position of the body. Passing in the wrapper property will tell Rellax to watch that element instead
         */
        wrapper?: string | HTMLElement | undefined;
        /**
         * Do we want rellax element to be relative to the mentioned wrapper.
         */
        relativeToWrapper?: boolean | undefined;

        /**
         * Each breakpoint value represents the resolution for mobile, tablet, desktop respectively.
         */
        breakpoints?: [number, number, number] | undefined;
    }
}

declare const Rellax: Rellax.Rellax;

export = Rellax;
export as namespace Rellax;