@types/html2canvas - npm Package Compare versions

Comparing version 0.0.32 to 0.0.33

html2canvas/index.d.ts

@@ -1,5 +0,6 @@
-// Type definitions for html2canvas.js v0.5.0-bata.4
+// Type definitions for html2canvas.js 1.0-alpha
 // Project: https://github.com/niklasvh/html2canvas
-// Definitions by: Richard Hepburn <https://github.com/rwhepburn/>, Pei-Tang Huang <https://github.com/tan9/>
+// Definitions by: Richard Hepburn <https://github.com/rwhepburn>, Pei-Tang Huang <https://github.com/tan9>, Sebastian Schocke <https://github.com/sschocke>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
 
@@ -10,2 +11,5 @@ /// <reference types="jquery"/>
     interface Html2CanvasOptions {
+        /** Whether to parse and render the element asynchronously */
+        async?: boolean;
+
         /** Whether to allow cross-origin images to taint the canvas */
@@ -15,7 +19,16 @@ allowTaint?: boolean;
         /** Canvas background color, if none is specified in DOM. Set undefined for transparent */
-        background?: string;
+        backgroundColor?: string;
 
-        /** Define the heigt of the canvas in pixels. If null, renders with full height of the window. */
-        height?: number;
+        /** Existing canvas element to use as a base for drawing on */
+        canvas?: any;
 
+        /** Whether to use ForeignObject rendering if the browser supports it */
+        foreignObjectRendering?: boolean;
+        
+        /** Predicate function which removes the matching elements from the render. */
+        ignoreElements?: (element: HTMLElement) => boolean;
+        
+        /** Timeout for loading images, in milliseconds. Setting it to 0 will result in no timeout. */
+        imageTimeout?: number;
+        
         /** Whether to render each letter seperately. Necessary if letter-spacing is used. */
@@ -30,7 +43,16 @@ letterRendering?: boolean;
 
+        /** Whether to cleanup the cloned DOM elements html2canvas creates temporarily */
+        removeContainer?: boolean;
+
+        /** The scale to use for rendering. Defaults to the browsers device pixel ratio. */
+        scale?: number;
+
+        /** Use svg powered rendering where available (FF11+). */
+        svgRendering?: boolean;
+        
         /** Whether to test each image if it taints the canvas before drawing them */
         taintTest?: boolean;
 
-        /** Timeout for loading images, in milliseconds. Setting it to 0 will result in no timeout. */
-        timeout?: number;
+        /** Whether to attempt to load cross-origin images as CORS served, before reverting back to proxy. */
+        useCORS?: boolean;
 
@@ -40,7 +62,22 @@ /** Define the width of the canvas in pixels. If null, renders with full width of the window. */
 
-        /** Whether to attempt to load cross-origin images as CORS served, before reverting back to proxy. */
-        useCORS?: boolean;
-        
-        /** Use svg powered rendering where available (FF11+). */
-        svgRendering?: boolean;
+        /** Define the heigt of the canvas in pixels. If null, renders with full height of the window. */
+        height?: number;
+
+        /** Crop canvas x-coordinate */
+        x?: number;
+
+        /** Crop canvas y-coordinate */
+        y?: number;
+
+        /** The x-scroll position to used when rendering element, (for example if the Element uses position: fixed ) */
+        scrollX?: number;
+
+        /** The y-scroll position to used when rendering element, (for example if the Element uses position: fixed ) */
+        scrollY?: number;
+
+        /** Window width to use when rendering Element, which may affect things like Media queries */
+        windowWidth?: number;
+
+        /** Window height to use when rendering Element, which may affect things like Media queries */
+        windowHeight?: number;
     }
@@ -47,0 +84,0 @@ }

html2canvas/package.json

 {
     "name": "@types/html2canvas",
-    "version": "0.0.32",
-    "description": "TypeScript definitions for html2canvas.js v0.5.0-bata.4",
+    "version": "0.0.33",
+    "description": "TypeScript definitions for html2canvas.js 1.0-alpha",
     "license": "MIT",
-    "author": "Richard Hepburn <https://github.com/rwhepburn/>, Pei-Tang Huang <https://github.com/tan9/>",
+    "contributors": [
+        {
+            "name": "Richard Hepburn",
+            "url": "https://github.com/rwhepburn",
+            "githubUsername": "rwhepburn"
+        },
+        {
+            "name": "Pei-Tang Huang",
+            "url": "https://github.com/tan9",
+            "githubUsername": "tan9"
+        },
+        {
+            "name": "Sebastian Schocke",
+            "url": "https://github.com/sschocke",
+            "githubUsername": "sschocke"
+        }
+    ],
     "main": "",
@@ -16,4 +32,4 @@ "repository": {
     },
-    "peerDependencies": {},
-    "typesPublisherContentHash": "15d60ca073e38234a762e1ca872b7a14cc4d0242cb848ba654bb5d2f4099c927"
+    "typesPublisherContentHash": "dda245d05da4f0839e1061ce97005b246e4995bc9d2e0bef65c86bb06be4b83a",
+    "typeScriptVersion": "2.3"
 }

html2canvas/README.md

@@ -5,14 +5,13 @@ # Installation
 # Summary
-This package contains type definitions for html2canvas.js v0.5.0-bata.4 (https://github.com/niklasvh/html2canvas).
+This package contains type definitions for html2canvas.js 1.0-alpha (https://github.com/niklasvh/html2canvas).
 
 # Details
-Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/html2canvas
+Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/html2canvas
 
 Additional Details
- * Last updated: Tue, 13 Dec 2016 21:09:28 GMT
- * Library Dependencies: jquery
- * Module Dependencies: none
+ * Last updated: Wed, 11 Apr 2018 19:02:33 GMT
+ * Dependencies: jquery
  * Global values: html2canvas
 
 # Credits
-These definitions were written by Richard Hepburn <https://github.com/rwhepburn/>, Pei-Tang Huang <https://github.com/tan9/>.
+These definitions were written by Richard Hepburn <https://github.com/rwhepburn>, Pei-Tang Huang <https://github.com/tan9>, Sebastian Schocke <https://github.com/sschocke>.

No alert changes

Improved metrics

Total package byte prevSize

7865

increased by41.74%

Lines of code

84

increased by1.2%

Worsened metrics

Number of lines in readme file

17

decreased by-5.56%

No dependency changes