Merge pull request #24068 from AndersonFriaca/ez-plus

Types for JQuery ElevateZoom Plus Plugin

types/ez-plus/ez-plus-tests.ts

@@ -0,0 +1,14 @@
+import { Options } from "ez-plus";
+
+$(document).ready(() => {
+    // basic usage
+    $('#image').ezPlus();
+
+    // with options
+    const options: Options = {
+        zoomLens: true,
+        zoomType: 'lens',
+        cursor: 'crosshair'
+    };
+    $('#image').ezPlus(options);
+});

types/ez-plus/index.d.ts

@@ -0,0 +1,214 @@
+// Type definitions for jQuery ElevateZoom Plus Plugin 1.2
+// Project: https://github.com/igorlino/elevatezoom-plus
+// Definitions by: Anderson Friaça <https://github.com/AndersonFriaca>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
+
+/// <reference types="jquery" />
+
+export interface Options {
+    /**
+     * Activate responsivenes
+     */
+    responsive?: boolean;
+
+    /**
+     * Activate zoom on mouse scroll
+     */
+    scrollZoom?: boolean;
+
+    /**
+     * Activate simultaneous crossfade of images on gallery change
+     */
+    imageCrossfade?: boolean;
+
+    /**
+     * Activate spinner icon or url
+     */
+    loadingIcon?: boolean | string;
+
+    /**
+     * Activate easing
+     */
+    easing?: boolean;
+    easingType?: string;
+    easingDuration?: number;
+
+    /**
+     * Used when zoomType set to lens
+     */
+    lensSize?: number;
+
+    /**
+     * Width of the zoomWindow
+     */
+    zoomWindowWidth?: number;
+
+    /**
+     * Height of the zoomWindow
+     */
+    zoomWindowHeight?: number;
+
+    /**
+     * x-axis offset of the zoom window
+     */
+    zoomWindowOffsetX?: number;
+
+    /**
+     * y-axis offset of the zoom window
+     */
+    zoomWindowOffsetY?: number;
+    zoomWindowPosition?: number | string;
+
+    /**
+     * Speed of Lens fadeIn
+     */
+    lensFadeIn?: number;
+
+    /**
+     * Speed of Lens fadeOut
+     */
+    lensFadeOut?: number;
+
+    /**
+     * Speed of Window fadeIn
+     */
+    zoomWindowFadeIn?: number;
+
+    /**
+     * Speed of Window fadeOut
+     */
+    zoomWindowFadeOut?: number;
+
+    /**
+     * Speed of Tint fadeIn
+     */
+    zoomTintFadeIn?: number;
+
+    /**
+     * Speed of Tint fadeOut
+     */
+    zoomTintFadeOut?: number;
+
+    /**
+     * Border Size of the ZoomBox
+     */
+    borderSize?: number;
+
+    /**
+     * Enable Lens
+     */
+    zoomLens?: boolean;
+
+    /**
+     * Border Colour
+     */
+    borderColour?: string;
+
+    /**
+     * Width in pixels of the lens border
+     */
+    lensBorder?: number;
+
+    /**
+     * Type of lens
+     */
+    lensShape?: 'square' | 'round';
+
+    /**
+     * Type of zoom
+     */
+    zoomType?: 'lens' | 'window' | 'inner';
+    containLensZoom?: boolean;
+
+    /**
+     * Colour of the lens background
+     */
+    lensColour?: string;
+
+    /**
+     * Opacity of lens
+     */
+    lensOpacity?: number;
+    lenszoom?: boolean;
+
+    /**
+     * Enable a tint overlay
+     */
+    tint?: boolean;
+
+    /**
+     * Colour of the tin
+     */
+    tintColour?: string;
+
+    /**
+     * Opacity of the tint
+     */
+    tintOpacity?: number;
+
+    /**
+     * This assigns a set of gallery links to the zoom image
+     */
+    gallery?: string;
+
+    /**
+     * Type of cursor
+     */
+    cursor?: 'default' | 'cursor' | 'crosshair';
+    container?: string;
+
+    /**
+     * Attribute to plugin use for zoom
+     */
+    attrImageZoomSrc?: string;
+
+    /**
+     * In pixels the dimensions you want to constrain on
+     */
+    constrainSize?: number | false;
+    constrainType?: 'width' | 'height';
+    debug?: boolean;
+    easingAmount?: number;
+    enabled?: boolean;
+    galleryActiveClass?: string;
+    gallerySelector?: string | false;
+    galleryItem?: string;
+    galleryEvent?: string;
+    mantainZoomAspectRatio?: boolean;
+    maxZoomLevel?: number | false;
+    minZoomLevel?: number;
+    preloading?: 0 | 1;
+    respond?: any[];
+
+    /**
+     * Steps of the scrollzoom
+     */
+    scrollZoomIncrement?: number;
+    touchEnabled?: boolean;
+    zoomActivation?: 'click' | 'hover';
+
+    /**
+     * Zoom container parent selector
+     */
+    zoomContainerAppendTo?: string;
+
+    /**
+     * Identifier for the zoom container
+     */
+    zoomId?: number;
+
+    /**
+     * Zoom level of image
+     */
+    zoomLevel?: number;
+    zIndex?: number;
+}
+declare global {
+    interface JQuery {
+        /**
+         * Initialize ElevateZoom Plugin
+         */
+        ezPlus(options?: Options): JQuery;
+    }
+}

types/ez-plus/tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true,
+        "esModuleInterop": true
+    },
+    "files": [
+        "index.d.ts",
+        "ez-plus-tests.ts"
+    ]
+}

types/ez-plus/tslint.json

@@ -0,0 +1 @@
+{"extends": "dtslint/dt.json"}