Package Health Score

74 / 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

Version				Vulnerabilities	License Risk
18.0.0	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
17.0.0	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
16.0.0	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.1	\|	12/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.0.0	\|	06/2022		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 (16,178)

GitHub Stars: 56
Forks: 10
Contributors: 5

Direct Usage Popularity

The npm package ng-qrcode receives a total of 16,178 downloads a week. As such, we scored ng-qrcode popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package ng-qrcode, we found that it has been starred 56 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: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like ng-qrcode is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 6
Open PR: 2
Last Release: 7 months ago
Last Commit: 8 days ago

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

We found that ng-qrcode 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: not defined

Age: 8 years
Dependencies: 2 Direct
Versions: 35
Install Size: 69.2 kB
Dist-tags: 1
# of Files: 18
Maintainers: 2
TS Typings: Yes

ng-qrcode 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

Angular QR Code Generator

Easy to use QR code generator for Angular projects.

Features:

Compatible with Angular 18
Leverages the widely used qrcode package to do the heavy lifting
Renders to HTML Canvas

Change Log

Installation

Add as a dependency to your angular application:

npm install ng-qrcode --save

Usage

Import into your consuming module (Eg: AppModule):

import { QrCodeModule } from 'ng-qrcode';

@NgModule({
  imports: [
    QrCodeModule
  ]
})

Component

value: string (required)

The value to encode in the QR code, eg: a url

size: string | number (optional)

An optional size in pixels to render at

Default: automatic size based on the value provided (recommended)

darkColor: RGBAColor (optional)

An RGBA Hex string to use as the color for the dark / filled modules. If an invalid value is passed, the default will be used.

Default black ("#000000FF")

lightColor: RGBAColor (optional)

An RGBA Hex string to use as the color for the empty space. If an invalid value is passed, the default will be used.

Default white ("#FFFFFFFF")

style: { [klass: string]: any; } (optional)

Inline style object, passed to the inner canvas element as [ngStyle]

styleClass: string (optional)

CSS Class, passed to the inner canvas element

errorCorrectionLevel: string (optional)

Controls the amount of redundant information included to make the QR code more likely to scan correctly if it is dirty / damaged

Default: "M"

Valid values: "L", "M", "Q", "H" - where "L" is the lowest amount of redundancy, and "H" is the highest

See: https://www.npmjs.com/package/qrcode#error-correction-level for further details

centerImageSrc: string (optional)

A URI suitable to use an a Image src property to load and render in the center of the QR code.

Note: the image will obscure part of the QR code, and therefore you should err on the side of a higher error correction level, anecdotally when the size is less than 1/4 of the size of the code, with at least "M" error correction, it is generally still scannable.

centerImageSize: string | number (optional)

An optional size in pixels to render the center image.

Default: 60

margin: number (optional)

An optional amount of margin to be rendered within the canvas element. Defaults to 4, where the unit is the size of one "dot" in the QR code.

Directive

If the provided component is not flexible enough for you, there is also a directive provided that is used by the component under the hood, which provides finer grain control.

Demo

See running demo here

A demo app is included in the repository under projects/ng-qrcode-demo which can be run locally using ng build && ng serve

Angular compatibility matrix

See table below for a history of versions and their Angular compatibility.

From version 16 onwards the library major version will match the Angular major version.

Angular Version	ng-qrcode Versions
^18	^18
^17	^17
^16	^16
^15	^8
^14	^7
^13	^6
^12	^5
^10 / ^11	^4
^7 / ^8	^3
^7	^2

Known / Common Issues

Reference Error 'global' is not defined

Essentially in some cases Angular will bundle a version of the buffer library that is not compatible with web browsers if the 'global' object is not defined.

This can be easily worked around, see comment here for options: https://github.com/mnahkies/ng-qrcode/issues/2#issuecomment-563414305

Footnote / Package History

Pre-version 2.0.0 this package was developed by emin93 and used the qrious npm package to generate the QR Codes.

The source for this was lost, and this repository is a re-write, first released as v2.0.0 that uses the qrcode npm package to generate QR Codes.

v2.0.0 should be backwards compatible, aside from a rename of the exported NgModule from QRCodeModule -> QrCodeModule for consistency.

ng-qrcode dependencies

qrcode tslib

FAQs

What is ng-qrcode?

Simple AOT compatible QR code generator for your Angular project. Visit Snyk Advisor to see a full health score report for ng-qrcode, including popularity, security, maintenance & community analysis.

Is ng-qrcode popular?

The npm package ng-qrcode receives a total of 16,178 weekly downloads. As such, ng-qrcode popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ng-qrcode well maintained?

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

Is ng-qrcode safe to use?

The npm package ng-qrcode 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 09:33 (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