react-scratchingcard 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dopey2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,160 @@
+# react-scratchingcard
+
+> A scratchcard component for React
+
+[![NPM](https://img.shields.io/npm/v/react-scratchingcard.svg)](https://www.npmjs.com/package/react-scratchingcard) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+
+##### Original repo by Aleksik (not maintained)
+https://github.com/aleksik/react-scratchcard
+
+##### Improvement ✨
+- Resize the image using width and height props (in the original repo, the image was croped)
+- Smooth fade out animation on scratch complete
+- Add type definition (ts)
+- Change brush size through props
+- Use custom brush through props
+- Define a custom check zone through props
+
+## Demo
+
+![scratchcard-demo](https://user-images.githubusercontent.com/22329040/140519100-b6ee86e3-0009-4ab6-bcd0-c7fefdb8720d.gif)
+
+## Install
+
+```bash
+npm install --save react-scratchingcard
+```
+or
+```bash
+yarn add react-scratchingcard
+```
+
+
+## Usage
+
+```tsx
+import React, { useRef }  from 'react';
+import ScratchCard from 'react-scratchcard-v2';
+
+import * as IMG from './img.jpg';
+
+const App = () => {
+
+  const ref = useRef<ScratchCard>(null);
+
+  const onClickReset = () => {
+    ref.current && ref.current.reset();
+  }
+
+  return (
+    <div>
+      <button onClick={onClickReset}>Reset</button>
+      <ScratchCard
+        width={320}
+        height={226}
+        image={IMG}
+        finishPercent={80}
+        onComplete={() => console.log('complete')}
+      >
+        <div style={{
+          display: 'flex',
+          width: '100%',
+          height: '100%',
+          alignItems: 'center',
+          justifyContent: 'center'
+        }}
+        >
+          <h1>Scratch card</h1>
+        </div>
+      </ScratchCard>
+    </div>
+  );
+};
+```
+
+### Custom brush
+
+```tsx
+const App = () => {
+  return (
+    <div>
+      <ScratchCard
+        width={320}
+        height={226}
+        image={IMG}
+        finishPercent={80}
+        customBrush={{
+          image: require('./brush.img'),
+          width: 15,
+          height: 15
+        }}
+      >
+        <h1>Scratch card</h1>
+      </ScratchCard>
+    </div>
+  );
+};
+```
+
+or you can use CUSTOM_BRUSH_PRESET object
+
+```tsx
+import { CUSTOM_BRUSH_PRESET } from 'react-scratchcard-v2';
+
+const App = () => {
+  return (
+    <div>
+      <ScratchCard
+        width={320}
+        height={226}
+        image={IMG}
+        finishPercent={80}
+        customBrush={CUSTOM_BRUSH_PRESET}
+      >
+        <h1>Scratch card</h1>
+      </ScratchCard>
+    </div>
+  )
+}
+```
+
+
+## Type
+
+### Props
+
+| **name**          | **type**        | **default** |
+|-------------------|-----------------|-------------|
+| width             | number          |             |
+| height            | number          |             |
+| image             | File or Base64  |             |
+| finishPercent     | ?number         | 70          |
+| brushSize         | ?number         | 20          |
+| fadeOutOnComplete | ?boolean        | true        |
+| onComplete        | ?callback       |             |
+| customBrush       | ?CustomBrush    |             |
+| customCheckZone   | ?CustomCheckZone|             |
+
+### CustomBrush
+
+| **name** | **type**       |
+|----------|----------------|
+| width    | number         |
+| height   | number         |
+| image    | File or Base64 |
+
+### CustomCheckZone
+
+| **name** | **type**       |
+|----------|----------------|
+| x        | number         |
+| y        | number         |
+| width    | number         |
+| height   | number         |
+
+
+
+## License
+
+MIT © [exaland](https://github.com/exaland)

package/dist/index.d.ts

@@ -0,0 +1,58 @@
+import React, { Component } from 'react';
+declare type Point = {
+    x: number;
+    y: number;
+};
+declare type CustomBrush = {
+    image: any;
+    width: number;
+    height: number;
+};
+declare type CustomCheckZone = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+interface Props {
+    width: number;
+    height: number;
+    image: any;
+    finishPercent?: number;
+    onComplete?: () => void;
+    brushSize?: number;
+    fadeOutOnComplete?: boolean;
+    children?: any;
+    customBrush?: CustomBrush;
+    customCheckZone?: CustomCheckZone;
+}
+interface State {
+    loaded: boolean;
+    finished: boolean;
+}
+declare class Scratch extends Component<Props, State> {
+    isDrawing: boolean;
+    lastPoint: Point | null;
+    ctx: CanvasRenderingContext2D;
+    canvas: HTMLCanvasElement;
+    brushImage?: any;
+    image: HTMLImageElement;
+    isFinished: boolean;
+    constructor(props: Props);
+    componentDidMount(): void;
+    reset: () => void;
+    getFilledInPixels(stride: number): number;
+    getMouse(e: any, canvas: HTMLCanvasElement): {
+        x: number;
+        y: number;
+    };
+    distanceBetween(point1: Point | null, point2: Point | null): number;
+    angleBetween(point1: Point | null, point2: Point | null): number;
+    handlePercentage(filledInPixels?: number): void;
+    handleMouseDown: (e: any) => void;
+    handleMouseMove: (e: any) => void;
+    handleMouseUp: () => void;
+    render(): React.JSX.Element;
+}
+export default Scratch;
+export declare const CUSTOM_BRUSH_PRESET: CustomBrush;