View @yudiel/react-qr-scann… on Snyk Open Source Advisor

Package Health Score

73 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.1.0	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.8	\|	08/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.10	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.10	\|	07/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.9	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (38,464)

GitHub Stars: 266
Forks: 44
Contributors: 6

Direct Usage Popularity

The npm package @yudiel/react-qr-scanner receives a total of 38,464 downloads a week. As such, we scored @yudiel/react-qr-scanner popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @yudiel/react-qr-scanner, we found that it has been starred 266 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @yudiel/react-qr-scanner is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 5
Open PR: 0
Last Release: 10 days ago
Last Commit: 10 days ago

Further analysis of the maintenance status of @yudiel/react-qr-scanner based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @yudiel/react-qr-scanner demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 2 Direct
Versions: 67
Install Size: 317 kB
Dist-tags: 2
# of Files: 175
Maintainers: 1
TS Typings: No

@yudiel/react-qr-scanner has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Features

Scan codes using a smartphone camera or webcam.

Demo

Checkout the Demo.

Install

yarn add @yudiel/react-qr-scanner

npm install @yudiel/react-qr-scanner

Usage

import { Scanner } from '@yudiel/react-qr-scanner';

const App = () =&gt; {
    return  console.log(result)} /&gt;;
};

There is also a hook to get the available devices useDevices.

Supported Formats

1D Barcodes	2D Barcodes
Codabar	Aztec
Code 39	Data Matrix
Code 93	Matrix Codes
Code 128	Maxi Code
Databar	Micro QR Code
Databar Expanded	PDF 417
Dx Film Edge	QR Code
EAN 8	rMQR Code
EAN 13
ITF
Linear Codes
UPC A
UPC E

Scanner Props

Prop	Type	Required	Description
`onScan`	`(detectedCodes: IDetectedBarcode[]) => void`	Yes	Callback function that is called when one or more barcodes are detected.
`onError`	`(error: unknown) => void`	No	Callback function that is called when an error occurs while mounting the camera.
`constraints`	`MediaTrackConstraints`	No	Optional media track constraints to apply to the video stream.
`formats`	`BarcodeFormat[]`	No	List of barcode formats to detect.
`paused`	`boolean`	No	If `true`, scanning is paused.
`children`	`ReactNode`	No	Optional children to render inside the scanner component.
`components`	`IScannerComponents`	No	Custom components to use within the scanner.
`styles`	`IScannerStyles`	No	Custom styles to apply to the scanner and its elements.
`classNames`	`IScannerClassNames`	No	Custom classNames to apply to the scanner and its elements.
`allowMultiple`	`boolean`	No	If `true`, ignore same barcode being scanned.
`scanDelay`	`number`	No	Delay in milliseconds between scans.

Limitations

Due to browser implementations, the camera can only be accessed over https or localhost.
Beep sound in iOS will only work after user interaction.
Server-side rendering won't work, so only require the component when rendering in a browser environment.

Types

`BarcodeFormat`

'aztec' |
    'code_128' |
    'code_39' |
    'code_93' |
    'codabar' |
    'databar' |
    'databar_expanded' |
    'data_matrix' |
    'dx_film_edge' |
    'ean_13' |
    'ean_8' |
    'itf' |
    'maxi_code' |
    'micro_qr_code' |
    'pdf417' |
    'qr_code' |
    'rm_qr_code' |
    'upc_a' |
    'upc_e' |
    'linear_codes' |
    'matrix_codes' |
    'unknown';

`IDetectedBarcode`

export interface IDetectedBarcode {
    boundingBox: IBoundingBox;
    cornerPoints: IPoint[];
    format: string;
    rawValue: string;
}

`IScannerComponents`

export interface IScannerComponents {
    tracker?: TrackFunction;
    audio?: boolean;
    onOff?: boolean;
    torch?: boolean;
    zoom?: boolean;
    finder?: boolean;
}

`IScannerStyles`

export interface IScannerStyles {
    container?: CSSProperties;
    video?: CSSProperties;
    finderBorder?: number;
}

@yudiel/react-qr-scanner dependencies

barcode-detector webrtc-adapter

@yudiel/react-qr-scanner development dependencies

@rollup/plugin-commonjs @rollup/plugin-terser @rollup/plugin-typescript @storybook/addon-essentials @storybook/addon-interactions @storybook/addon-links @storybook/addon-webpack5-compiler-swc @storybook/react @storybook/react-webpack5 @types/node @types/react @types/react-dom rollup rollup-plugin-copy rollup-plugin-dts storybook typescript

FAQs

What is @yudiel/react-qr-scanner?

A library to scan QR codes in React. Visit Snyk Advisor to see a full health score report for @yudiel/react-qr-scanner, including popularity, security, maintenance & community analysis.

Is @yudiel/react-qr-scanner popular?

The npm package @yudiel/react-qr-scanner receives a total of 38,464 weekly downloads. As such, @yudiel/react-qr-scanner popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @yudiel/react-qr-scanner well maintained?

We found indications that @yudiel/react-qr-scanner maintenance is sustainable demonstrating some project activity. We saw a total of 6 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @yudiel/react-qr-scanner safe to use?

The npm package @yudiel/react-qr-scanner was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 December-2024, at 10:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP