react-native-qrcode-styled

v0.3.2

A fully customizable QR Code generator for React Native based on react-native-svg and javascript-qrcode. For more information about how to use this package see README

Latest version published 5 months ago

License: MIT

NPM

GitHub

Package Health Score

70 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

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
0.3.2	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.2	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	02/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

Small

Weekly Downloads (6,042)

GitHub Stars: 156
Forks: 7
Contributors: 1

Direct Usage Popularity

The npm package react-native-qrcode-styled receives a total of 6,042 downloads a week. As such, we scored react-native-qrcode-styled popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package react-native-qrcode-styled, we found that it has been starred 156 times.

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

Community

Active

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

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 5
Open PR: 0
Last Release: 5 months ago
Last Commit: 5 months ago

Further analysis of the maintenance status of react-native-qrcode-styled based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that react-native-qrcode-styled demonstrates a positive version release cadence with at least one new version released in the past 12 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: >= 16.0.0

Age: 2 years
Dependencies: 2 Direct
Versions: 9
Install Size: 261 kB
Dist-tags: 1
# of Files: 94
Maintainers: 1
TS Typings: No

react-native-qrcode-styled 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

npm npm github

react-native-qrcode-styled

Fully customizable QR Codes generator for React Native using react-native-svg

Shadows Demo

Installation

npm i react-native-svg react-native-qrcode-styled

or with yarn

yarn add react-native-svg react-native-qrcode-styled

If you use typescript, run:

yarn add -D @types/qrcode

Usage

Simple usage is:

import QRCodeStyled from 'react-native-qrcode-styled';

For more examples check out the Example app

Props

Name	Default	Type	Description
data	"I'm QR Code!"	string	Message for encoding. Can also be an array. More info HERE.
pieceSize	5	number	Size of each piece of the QR code
pieceScale	undefined	SvgProps['scale']	Scale of each piece of the QR code
pieceRotation	undefined	SvgProps['rotation']	Angle of rotation of each piece of the QR code (in degrees)
pieceCornerType	'rounded'	'rounded' \| 'cut'	Type of piece corner
pieceBorderRadius	0	number \| number[]	Border radius of all corners of each piece. Can also be an array to define different border radius for each corner (start from top-left corner)
pieceStroke	undefined	ColorValue	Border color of each piece
pieceStrokeWidth	undefined	number	Border with of each piece
pieceLiquidRadius	undefined	number	Level of liquid effect between pieces. If you have `pieceBorderRadius` set `isPiecesGlued` to true
isPiecesGlued	false	boolean	If true between pieces will be glue effect. You will see this if you have `pieceBorderRadius` > 0
outerEyesOptions	undefined	EyeOptions \| AllEyesOptions	Configurations for outer eyes of QR code. If they defined, previous piece configurations won't be work
innerEyesOptions	undefined	EyeOptions \| AllEyesOptions	The same as `outerEyesOptions` prop but for inner eyes
color	'black'	ColorValue	Color of QR code
gradient	undefined	GradientProps	Gradient of QR code. Can be two types: 'linear' \| 'radial'. By default 'linear'
padding	undefined	number	Padding inside `<svg></svg>` component from QR code
logo	undefined	LogoOptions	Configurations for logo. Support svg's `<img>` props
backgroundImage	undefined	svg's `<img>` props type	Background image for QR code
version	undefined	number	Description
maskPattern	undefined	number	Description
toSJISFunc	undefined	function	Description
errorCorrectionLevel	'M'	'L' \| 'M' \| 'Q' \| 'H'	Description
renderCustomPieceItem	undefined	RenderCustomPieceItem	Render custom piece of QR code. It must return svg component. If it defined, previous piece and eyes configurations won't be work
renderBackground	undefined	(pieceSize: number, bitMatrix: number[][]) => SvgProps['children']	Ability to add any additional svg components behind qr code
children	undefined	(pieceSize: number, bitMatrix: number[][]) => SvgProps['children']	Ability to add any additional svg components as children
...rest `<svg></svg>` props

Types

GradientProps

type GradientType = 'linear' | 'radial';

type LinearGradientProps = {
  colors?: ColorValue[];
  start?: [number, number]; // start point [x, y] (0 -&gt; 0%, 1 -&gt; 100%)
  end?: [number, number]; // end point [x, y] (0 -&gt; 0%, 1 -&gt; 100%)
  locations?: number[]; // list of colors positions (0 -&gt; 0%, 1 -&gt; 100%)
};

type RadialGradientProps = {
  colors?: ColorValue[];
  center?: [number, number]; // center point [x, y] (0 -&gt; 0%, 1 -&gt; 100%)
  radius?: [number, number]; // radiusXY [x, y] (0 -&gt; 0%, 1 -&gt; 100%)
  locations?: number[]; // list of colors positions (0 -&gt; 0%, 1 -&gt; 100%)
};

type GradientProps = {
  type?: GradientType;
  options?: LinearGradientProps | RadialGradientProps;
};

EyeOptions

type EyeOptions = {
  scale?: PathProps['scale']; // scaleXY | [scaleX, scaleY]
  rotation?: string | number;
  borderRadius?: number | number[];
  color?: ColorValue;
  gradient?: GradientProps;
  stroke?: ColorValue;
  strokeWidth?: number;
}

AllEyesOptions

type EyePosition = 'topLeft' | 'topRight' | 'bottomLeft';

type AllEyesOptions = { [K in EyePosition]?: EyeOptions }

RenderCustomPieceItem

type RenderCustomPieceItem = ({x, y, pieceSize, qrSize, bitMatrix}: {
  x: number;
  y: number;
  pieceSize: number;
  qrSize: number;
  bitMatrix: number[][];
}) =&gt; React.ReactElement | null;

LogoOptions

export type LogoArea = {
  x: number;
  y: number;
  width: number;
  height: number;
};

export type LogoOptions = {
  hidePieces?: boolean;
  padding?: number;
  scale?: number;
  onChange?: (logoArea?: LogoArea) =&gt; void;
} &amp; SVGImageProps;

Troubleshooting

Gaps between pieces (only on Android)

If you'll see that gaps between pieces on Android, just scale pieces up a little bit:

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library

react-native-qrcode-styled dependencies

qrcode react-fast-compare

FAQs

What is react-native-qrcode-styled?

A fully customizable QR Code generator for React Native based on react-native-svg and javascript-qrcode. Visit Snyk Advisor to see a full health score report for react-native-qrcode-styled, including popularity, security, maintenance & community analysis.

Is react-native-qrcode-styled popular?

The npm package react-native-qrcode-styled receives a total of 6,042 weekly downloads. As such, react-native-qrcode-styled popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-native-qrcode-styled well maintained?

We found indications that react-native-qrcode-styled maintenance is sustainable demonstrating some project activity. We saw a total of 1 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is react-native-qrcode-styled safe to use?

The npm package react-native-qrcode-styled 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 18 November-2024, at 03:30 (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

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6,042)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

react-native-qrcode-styled

Installation

Usage

Props

Types

GradientProps

EyeOptions

AllEyesOptions

RenderCustomPieceItem

LogoOptions

Troubleshooting

Gaps between pieces (only on Android)

Contributing

License

react-native-qrcode-styled dependencies

react-native-qrcode-styled development dependencies

FAQs

What is react-native-qrcode-styled?

Is react-native-qrcode-styled popular?

Is react-native-qrcode-styled well maintained?

Is react-native-qrcode-styled safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues