ngx-kjua - npm Package Compare versions

Comparing version 18.0.0 to 18.1.0

lib/ngx-kjua.interface.d.ts

 export type KjuaRender = "image" | "svg" | "canvas";
 export type KjuaEcLevel = "L" | "M" | "Q" | "H";
-export type KjuaMode = "plain" | "label" | "image" | "imagelabel" | "labelimage";
+export type KjuaMode = "plain" | "label" | "image" | "imagelabel" | "clearimage" | "labelimage";

package.json

 {
   "name": "ngx-kjua",
   "description": "Angular QR-Code generator component.",
-  "version": "18.0.0",
+  "version": "18.1.0",
   "license": "MIT",
@@ -6,0 +6,0 @@ "private": false,

README.md

 [![NPM version](https://img.shields.io/npm/v/ngx-kjua.svg?&label=npm)](https://www.npmjs.com/package/ngx-kjua) 
-[![Dependency Status](https://david-dm.org/werthdavid/ngx-kjua.svg)](https://david-dm.org/werthdavid/ngx-kjua)
 [![Downloads](https://img.shields.io/npm/dm/ngx-kjua.svg)](https://npmjs.org/package/ngx-kjua)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) 
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2ef6c180329a44cc9fd95abc77fc8c1d)](https://www.codacy.com/app/werthdavid/ngx-kjua?utm_source=github.com&utm_medium=referral&utm_content=werthdavid/ngx-kjua&utm_campaign=Badge_Grade)
 <img align="right" src="https://raw.githubusercontent.com/werthdavid/ngx-kjua/master/docs/readme-logo.png"/>
@@ -113,2 +111,4 @@
 
+:exclamation: *Caution*: When adding images, label or similar, this will reduce the readability of the QR-code. Consider using a higher error correction level (e.g. L) in those cases.
+
 ### Crisp
@@ -135,3 +135,9 @@
 
-### Labelimage and Imagelabel
+### Clear + Image
+<img src="https://raw.githubusercontent.com/werthdavid/ngx-kjua/master/docs/clearimage.png"/>
+
+This mode let's you "cut out" parts of the QR-code and at the same time add an image.
+
+
+### labelimage, imagelabel and clearimage
 Use this, if you want a label AND an image. In these modes `mSize`, `mPosX` and `mPosY` can be provided as an array.
@@ -154,3 +160,3 @@ In mode `labelimage`, the first value (index 0) of the `mSize`, `mPosX` and `mPosY` arrays is used for the label,
 * `quiet` quiet zone in modules (defaults to `0`)
-* `mode` modes: 'plain', 'label' or 'image' (defaults to `plain`, set `label` or `image` property if you change this)
+* `mode` modes: 'plain', 'label', 'image' or 'clear' (defaults to `plain`, set `label` or `image` property if you change this)
 * `mSize` label/image size in pc: 0..100 (defaults to `30`)
@@ -157,0 +163,0 @@ * `mPosX` label/image pos x in pc: 0..100 (defaults to `50`)

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

241276

increased by210.67%

Number of package files

33

increased by94.12%

Lines of code

2300

increased by157.56%

Number of lines in readme file

198

increased by3.13%

No dependency changes