@types/drift-zoom

Installation

npm install --save @types/drift-zoom

Summary

This package contains type definitions for drift-zoom (https://github.com/imgix/drift).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/drift-zoom.

index.d.ts

export as namespace Drift;

declare class Drift {
    constructor(triggerEl: HTMLElement, options?: Drift.Options);

    readonly isShowing: boolean;
    zoomFactor: number;

    setZoomImageURL(imageURL: string): void;
    disable(): void;
    enable(): void;
    destroy(): void;
}

declare namespace Drift {
    interface Options {
        /** @default 'drift-' */
        namespace?: string | null | undefined;
        /** @default false */
        showWhitespaceAtEdges?: boolean | undefined;
        /** @default false */
        containInline?: boolean | undefined;
        /** @default 0 */
        inlineOffsetX?: number | undefined;
        /** @default 0 */
        inlineOffsetY?: number | undefined;
        /** @default document.body */
        inlineContainer?: HTMLElement | undefined;
        /** @default 'data-zoom' */
        sourceAttribute?: string | undefined;
        /** @default 3 */
        zoomFactor?: number | undefined;
        /** @default document.body */
        paneContainer?: HTMLElement | undefined;
        /** @default 375 */
        inlinePane?: number | undefined;
        /** @default true */
        handleTouch?: boolean | undefined;
        onShow?: (() => void) | null | undefined;
        onHide?: (() => void) | null | undefined;
        /** @default true */
        injectBaseStyles?: boolean | undefined;
        /** @default 0 */
        hoverDelay?: number | undefined;
        /** @default 0 */
        touchDelay?: number | undefined;
        /** @default false */
        hoverBoundingBox?: boolean | undefined;
        /** @default false */
        touchBoundingBox?: boolean | undefined;
        /** @default document.body */
        boundingBoxContainer?: HTMLElement | undefined;
        /** @default false */
        passive?: boolean | undefined;
    }
}

export = Drift;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: none

Credits

These definitions were written by Piotr Błażejewicz.