swiper/modules/zoom/zoom.d.ts

Most modern mobile touch slider and framework with hardware accelerated transitions

import type { Swiper, SwiperModule } from '../../core/core.js';
export interface ZoomOptions {
    /**
     * !INTERNAL Toggled by the runtime when the module's `enabled` defaults flip
     * through extendParams; consumers should pass `zoom: true` or
     * `zoom: { ... }` rather than reading this flag.
     */
    enabled?: boolean;
    /**
     * When set to true, the image will not be scaled past 100% of its original size
     *
     * @default false
     */
    limitToOriginalSize?: boolean;
    /**
     * Maximum image zoom multiplier
     *
     * @default 3
     */
    maxRatio?: number;
    /**
     * Minimal image zoom multiplier
     *
     * @default 1
     */
    minRatio?: number;
    /**
     * When set to true, a zoomed in image will automatically pan while moving the mouse over the image
     *
     * @default false
     */
    panOnMouseMove?: boolean;
    /**
     * Enable/disable zoom-in by slide's double tap
     *
     * @default true
     */
    toggle?: boolean;
    /**
     * CSS class name of zoom container
     *
     * @default 'swiper-zoom-container'
     */
    containerClass?: string;
    /**
     * CSS class name of zoomed in container
     *
     * @default 'swiper-slide-zoomed'
     */
    zoomedSlideClass?: string;
}
export interface ZoomMethods {
    /**
     * Whether the zoom module is enabled
     */
    enabled: boolean;
    /**
     * Current image scale ratio
     */
    scale: number;
    /**
     * Enable zoom module
     */
    enable(): void;
    /**
     * Disable zoom module
     */
    disable(): void;
    /**
     * Zoom in image of the currently active slide. Optionally accepts custom zoom ratio
     */
    in(ratio?: number): void;
    /**
     * Zoom out image of the currently active slide
     */
    out(): void;
    /**
     * Toggle image zoom of the currently active slide
     */
    toggle(event?: MouseEvent | TouchEvent | PointerEvent): void;
}
export interface ZoomEvents {
    /**
     * Event will be fired on zoom change
     */
    zoomChange: (swiper: Swiper, scale: number, imageEl: HTMLElement, slideEl: HTMLElement) => void;
}
declare module '../../core/core.js' {
    interface Swiper {
        zoom: ZoomMethods;
    }
    interface SwiperOptions {
        /**
         * Enables zooming functionality. Object with zoom parameters or boolean `true` to enable with default settings
         *
         * @example
         * ```js
         * const swiper = new Swiper('.swiper', {
         *   zoom: {
         *     maxRatio: 5,
         *   },
         * });
         * ```
         */
        zoom?: ZoomOptions | boolean;
    }
    interface SwiperParams {
        zoom?: ZoomOptions;
    }
    interface SwiperEvents extends ZoomEvents {
    }
}
declare const Zoom: SwiperModule;
export default Zoom;