react-scratchingcard 1.0.0 → 1.0.1

package/README.md

@@ -35,7 +35,7 @@ yarn add react-scratchingcard
 
 ```tsx
 import React, { useRef }  from 'react';
-import ScratchCard from 'react-scratchcard-v2';
+import ScratchCard from 'react-scratchingcard';
 
 import * as IMG from './img.jpg';
 
@@ -100,7 +100,7 @@ const App = () => {
 or you can use CUSTOM_BRUSH_PRESET object
 
 ```tsx
-import { CUSTOM_BRUSH_PRESET } from 'react-scratchcard-v2';
+import { CUSTOM_BRUSH_PRESET } from 'react-scratchingcard';
 
 const App = () => {
   return (
@@ -128,7 +128,8 @@ const App = () => {
 |-------------------|-----------------|-------------|
 | width             | number          |             |
 | height            | number          |             |
-| image             | File or Base64  |             |
+| image             | File \| string \| {src?: string, default?: string}  |             |
+| imageCrossOrigin  | ?'' \| 'anonymous' \| 'use-credentials' | 'anonymous' |
 | finishPercent     | ?number         | 70          |
 | brushSize         | ?number         | 20          |
 | fadeOutOnComplete | ?boolean        | true        |
@@ -136,6 +137,21 @@ const App = () => {
 | customBrush       | ?CustomBrush    |             |
 | customCheckZone   | ?CustomCheckZone|             |
 
+### Remote URL
+
+```tsx
+<ScratchCard
+  width={320}
+  height={226}
+  image='https://cdn.example.com/scratch-cover.jpg'
+  imageCrossOrigin='anonymous'
+>
+  <h1>Scratch card</h1>
+</ScratchCard>
+```
+
+Note: pour calculer le pourcentage gratté (`finishPercent`) avec une image distante, le serveur distant doit autoriser CORS.
+
 ### CustomBrush
 
 | **name** | **type**       |

package/dist/index.d.ts

@@ -8,6 +8,10 @@ declare type CustomBrush = {
     width: number;
     height: number;
 };
+declare type ImageSource = string | File | {
+    src?: string;
+    default?: string;
+};
 declare type CustomCheckZone = {
     x: number;
     y: number;
@@ -17,7 +21,8 @@ declare type CustomCheckZone = {
 interface Props {
     width: number;
     height: number;
-    image: any;
+    image: ImageSource;
+    imageCrossOrigin?: '' | 'anonymous' | 'use-credentials';
     finishPercent?: number;
     onComplete?: () => void;
     brushSize?: number;
@@ -37,8 +42,14 @@ declare class Scratch extends Component<Props, State> {
     canvas: HTMLCanvasElement;
     brushImage?: any;
     image: HTMLImageElement;
+    objectUrl: string | null;
     isFinished: boolean;
     constructor(props: Props);
+    componentDidUpdate(prevProps: Props): void;
+    componentWillUnmount(): void;
+    revokeObjectUrl(): void;
+    resolveImageSource(image: ImageSource): string;
+    loadImage(): void;
     componentDidMount(): void;
     reset: () => void;
     getFilledInPixels(stride: number): number;

package/dist/index.js

@@ -28,6 +28,7 @@ var Scratch = /*#__PURE__*/function (_Component) {
     _this = _Component.call(this, props) || this;
     _this.isDrawing = false;
     _this.lastPoint = null;
+    _this.objectUrl = null;
     _this.isFinished = false;
 
     _this.reset = function () {
@@ -93,24 +94,75 @@ var Scratch = /*#__PURE__*/function (_Component) {
 
   var _proto = Scratch.prototype;
 
-  _proto.componentDidMount = function componentDidMount() {
+  _proto.componentDidUpdate = function componentDidUpdate(prevProps) {
+    if (prevProps.image !== this.props.image) {
+      this.loadImage();
+    }
+  };
+
+  _proto.componentWillUnmount = function componentWillUnmount() {
+    this.revokeObjectUrl();
+  };
+
+  _proto.revokeObjectUrl = function revokeObjectUrl() {
+    if (this.objectUrl) {
+      URL.revokeObjectURL(this.objectUrl);
+      this.objectUrl = null;
+    }
+  };
+
+  _proto.resolveImageSource = function resolveImageSource(image) {
+    this.revokeObjectUrl();
+
+    if (typeof image === 'string') {
+      return image;
+    }
+
+    if (image instanceof File) {
+      this.objectUrl = URL.createObjectURL(image);
+      return this.objectUrl;
+    }
+
+    if (image && typeof image.src === 'string') {
+      return image.src;
+    }
+
+    if (image && typeof image["default"] === 'string') {
+      return image["default"];
+    }
+
+    return '';
+  };
+
+  _proto.loadImage = function loadImage() {
     var _this2 = this;
 
-    this.isDrawing = false;
-    this.lastPoint = null;
-    this.ctx = this.canvas.getContext('2d');
     this.image = new Image();
-    this.image.crossOrigin = 'Anonymous';
+    this.image.crossOrigin = this.props.imageCrossOrigin === undefined ? 'anonymous' : this.props.imageCrossOrigin;
 
     this.image.onload = function () {
+      _this2.ctx.globalCompositeOperation = 'source-over';
+
+      _this2.ctx.clearRect(0, 0, _this2.props.width, _this2.props.height);
+
       _this2.ctx.drawImage(_this2.image, 0, 0, _this2.props.width, _this2.props.height);
 
+      _this2.isFinished = false;
+
       _this2.setState({
-        loaded: true
+        loaded: true,
+        finished: false
       });
     };
 
-    this.image.src = this.props.image;
+    this.image.src = this.resolveImageSource(this.props.image);
+  };
+
+  _proto.componentDidMount = function componentDidMount() {
+    this.isDrawing = false;
+    this.lastPoint = null;
+    this.ctx = this.canvas.getContext('2d');
+    this.loadImage();
 
     if (this.props.customBrush) {
       this.brushImage = new Image(this.props.customBrush.width, this.props.customBrush.height);