@yudiel/react-qr-scanner - npm Package Compare versions

Comparing version 2.0.0-beta.2 to 2.0.0-beta.3

dist/cjs/assets/CameraOff.d.ts

 import React, { CSSProperties } from 'react';
 interface IFlashOnProps {
     onClick: () => void;
+    disabled: boolean;
     className?: string;
@@ -5,0 +6,0 @@ style?: CSSProperties;

dist/cjs/assets/CameraOn.d.ts

 import React, { CSSProperties } from 'react';
 interface IFlashOnProps {
     onClick: () => void;
+    disabled: boolean;
     className?: string;
@@ -5,0 +6,0 @@ style?: CSSProperties;

dist/cjs/components/Finder.d.ts

@@ -5,3 +5,3 @@ import React from 'react';
 interface IFinderProps {
-    enabled: boolean;
+    scanning: boolean;
     loading: boolean;
@@ -8,0 +8,0 @@ video: HTMLVideoElement | null;

dist/cjs/components/OnOff.d.ts

 import React from 'react';
 interface ITorchProps {
-    enabled: boolean;
+    scanning: boolean;
     startScanning: (deviceId?: string | undefined) => void;
@@ -5,0 +5,0 @@ stopScanning?: () => void;

dist/cjs/components/Torch.d.ts

 import React from 'react';
 interface ITorchProps {
-    enabled: boolean;
+    scanning: boolean;
     switchTorch?: (value: boolean) => void;
@@ -5,0 +5,0 @@ }

dist/cjs/hooks/useContinuousScanner.d.ts

@@ -14,2 +14,3 @@ import { RefObject } from 'react';
     loading: boolean;
+    scanning: boolean;
     switchTorch?: (value: boolean) => void;
@@ -16,0 +17,0 @@ getSettings?: () => MediaTrackSettings | undefined;

dist/esm/assets/CameraOff.d.ts

 import React, { CSSProperties } from 'react';
 interface IFlashOnProps {
     onClick: () => void;
+    disabled: boolean;
     className?: string;
@@ -5,0 +6,0 @@ style?: CSSProperties;

dist/esm/assets/CameraOn.d.ts

 import React, { CSSProperties } from 'react';
 interface IFlashOnProps {
     onClick: () => void;
+    disabled: boolean;
     className?: string;
@@ -5,0 +6,0 @@ style?: CSSProperties;

dist/esm/components/Finder.d.ts

@@ -5,3 +5,3 @@ import React from 'react';
 interface IFinderProps {
-    enabled: boolean;
+    scanning: boolean;
     loading: boolean;
@@ -8,0 +8,0 @@ video: HTMLVideoElement | null;

dist/esm/components/OnOff.d.ts

 import React from 'react';
 interface ITorchProps {
-    enabled: boolean;
+    scanning: boolean;
     startScanning: (deviceId?: string | undefined) => void;
@@ -5,0 +5,0 @@ stopScanning?: () => void;

dist/esm/components/Torch.d.ts

 import React from 'react';
 interface ITorchProps {
-    enabled: boolean;
+    scanning: boolean;
     switchTorch?: (value: boolean) => void;
@@ -5,0 +5,0 @@ }

dist/esm/hooks/useContinuousScanner.d.ts

@@ -14,2 +14,3 @@ import { RefObject } from 'react';
     loading: boolean;
+    scanning: boolean;
     switchTorch?: (value: boolean) => void;
@@ -16,0 +17,0 @@ getSettings?: () => MediaTrackSettings | undefined;

dist/index.d.ts

@@ -54,2 +54,3 @@ import React, { CSSProperties, RefObject } from 'react';
     loading: boolean;
+    scanning: boolean;
     switchTorch?: (value: boolean) => void;
@@ -56,0 +57,0 @@ getSettings?: () => MediaTrackSettings | undefined;

package.json

 {
   "name": "@yudiel/react-qr-scanner",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "A library to scan qr codes in react.",
@@ -5,0 +5,0 @@ "author": "Yudiel Curbelo",

README.md

@@ -64,2 +64,13 @@ ### Features
 
+### IUseContinuousScannerReturn Interface
+| Property           | Type                                           | Description                                                              |
+|--------------------|------------------------------------------------|--------------------------------------------------------------------------|
+| `ref`              | `RefObject<HTMLVideoElement>`                  | A reference to the video element used for scanning.                      |
+| `startScanning`    | `() => void`                                   | A function to initiate the scanning process.                             |
+| `stopScanning`     | `() => void`                                   | A function to stop the scanning process.                                 |
+| `loading`          | `boolean`                                      | Indicates whether the scanner is in the process of initializing.         |
+| `scanning`         | `boolean`                                      | Indicates whether the scanner is currently active and scanning.          |
+| `switchTorch`      | `(value: boolean) => void` \| `undefined`      | An optional function to toggle the device's torch (flashlight) feature.  |
+| `getSettings`      | `() => MediaTrackSettings \| undefined`        | An optional function to get the current settings of the media track.     |
+
 ### Error Interface
@@ -66,0 +77,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5079824

increased by0.05%

Lines of code

4500

increased by0.2%

Number of lines in readme file

111

increased by11%

No dependency changes