@liquid-js/qr-code-styling 1.6.0-rc.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Denys Kozak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,232 @@
+# QR Code Styling
+[![Version](https://img.shields.io/npm/v/qr-code-styling.svg)](https://www.npmjs.org/package/qr-code-styling)
+
+JavaScript library for generating QR codes with a logo and styling.
+
+Try it here https://qr-code-styling.com
+
+If you have issues / suggestions / notes / questions, please open an issue or contact me. Let's create a cool library together.
+### Examples
+<p float="left">
+<img style="display:inline-block" src="https://raw.githubusercontent.com/kozakdenys/qr-code-styling/master/src/assets/facebook_example_new.png" width="240" />
+<img style="display:inline-block" src="https://raw.githubusercontent.com/kozakdenys/qr-code-styling/master/src/assets/qr_code_example.png" width="240" />
+<img style="display:inline-block" src="https://raw.githubusercontent.com/kozakdenys/qr-code-styling/master/src/assets/telegram_example_new.png" width="240" />
+</p>
+
+### Installation
+
+```
+npm install qr-code-styling
+```
+
+### Usage
+
+```HTML
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>QR Code Styling</title>
+    <script type="text/javascript" src="https://unpkg.com/qr-code-styling@1.5.0/lib/qr-code-styling.js"></script>
+</head>
+<body>
+<div id="canvas"></div>
+<script type="text/javascript">
+
+    const qrCode = new QRCodeStyling.QRCodeStyling({
+        width: 300,
+        height: 300,
+        type: "svg",
+        data: "https://www.facebook.com/",
+        image: "https://upload.wikimedia.org/wikipedia/commons/5/51/Facebook_f_logo_%282019%29.svg",
+        dotsOptions: {
+            color: "#4267b2",
+            type: "rounded"
+        },
+        backgroundOptions: {
+            color: "#e9ebee",
+        },
+        imageOptions: {
+            crossOrigin: "anonymous",
+            margin: 20
+        }
+    });
+
+    qrCode.append(document.getElementById("canvas"));
+    QRCodeStyling.browserUtils.download(qrCode);
+</script>
+</body>
+</html>
+```
+---
+
+[**React example (Codesandbox)**](https://codesandbox.io/s/qr-code-styling-react-example-l8rwl?file=/src/App.js)
+
+[**Angular example (Codesandbox)**](https://codesandbox.io/s/agitated-panini-tpgb2?file=/src/app/app.component.ts)
+
+---
+
+[**React example (source)**](https://github.com/kozakdenys/qr-code-styling-examples/tree/master/examples/react)
+
+[**Angular example (source)**](https://github.com/kozakdenys/qr-code-styling-examples/tree/master/examples/angular)
+
+[**Vue example (source)**](https://github.com/kozakdenys/qr-code-styling-examples/tree/master/examples/vue)
+
+---
+
+### API Documentation
+
+#### QRCodeStyling instance
+`new QRCodeStyling(options) => QRCodeStyling`
+
+Param  |Type  |Description
+-------|------|------------
+options|object|Init object
+
+`options` structure
+
+Property               |Type                     |Default Value|Description
+-----------------------|-------------------------|-------------|-----------------------------------------------------
+width                  |number                   |`300`        |Size of canvas
+height                 |number                   |`300`        |Size of canvas
+data                   |string                   |             |The date will be encoded to the QR code
+image                  |string                   |             |The image will be copied to the center of the QR code
+margin                 |number                   |`0`          |Margin around canvas
+qrOptions              |object                   |             |Options will be passed to `qrcode-generator` lib
+imageOptions           |object                   |             |Specific image options, details see below
+dotsOptions            |object                   |             |Dots styling options
+cornersSquareOptions   |object                   |             |Square in the corners styling options
+cornersDotOptionsHelper|object                   |             |Dots in the corners styling options
+backgroundOptions      |object                   |             |QR background styling options
+
+`options.qrOptions` structure
+
+Property            |Type                                              |Default Value
+--------------------|--------------------------------------------------|-------------
+typeNumber          |number (`0 - 40`)                                 |`0`
+mode                |string (`'Numeric' 'Alphanumeric' 'Byte' 'Kanji'`)|
+errorCorrectionLevel|string (`'L' 'M' 'Q' 'H'`)                        |`'Q'`
+
+`options.imageOptions` structure
+
+Property          |Type                                   |Default Value|Description
+------------------|---------------------------------------|-------------|------------------------------------------------------------------------------
+hideBackgroundDots|boolean                                |`true`       |Hide all dots covered by the image
+imageSize         |number                                 |`0.4`        |Coefficient of the image size. Not recommended to use ove 0.5. Lower is better
+margin            |number                                 |`0`          |Margin of the image in px
+crossOrigin       |string(`'anonymous' 'use-credentials'`)|             |Set "anonymous" if you want to download QR code from other origins.
+
+`options.dotsOptions` structure
+
+Property|Type                                                                          |Default Value|Description
+--------|------------------------------------------------------------------------------|-------------|-------------------
+color   |string                                                                        |`'#000'`     |Color of QR dots
+gradient|object                                                                        |             |Gradient of QR dots
+type    |string (`'rounded' 'dots' 'classy' 'classy-rounded' 'square' 'extra-rounded'`)|`'square'`   |Style of QR dots
+
+`options.backgroundOptions` structure
+
+Property|Type  |Default Value
+--------|------|-------------
+color   |string|`'#fff'`
+gradient|object|
+
+`options.cornersSquareOptions` structure
+
+Property|Type                                     |Default Value|Description
+--------|-----------------------------------------|-------------|-----------------
+color   |string                                   |             |Color of Corners Square
+gradient|object                                   |             |Gradient of Corners Square
+type    |string (`'dot' 'square' 'extra-rounded'`)|             |Style of Corners Square
+
+`options.cornersDotOptions` structure
+
+Property|Type                     |Default Value|Description
+--------|-------------------------|-------------|-----------------
+color   |string                   |             |Color of Corners Dot
+gradient|object                   |             |Gradient of Corners Dot
+type    |string (`'dot' 'square'`)|             |Style of Corners Dot
+
+Gradient structure
+
+`options.dotsOptions.gradient`
+
+`options.backgroundOptions.gradient`
+
+`options.cornersSquareOptions.gradient`
+
+`options.cornersDotOptions.gradient`
+
+Property  |Type                        |Default Value|Description
+----------|----------------------------|-------------|---------------------------------------------------------
+type      |string (`'linear' 'radial'`)|"linear"     |Type of gradient spread
+rotation  |number                      |0            |Rotation of gradient in radians (Math.PI === 180 degrees)
+colorStops|array of objects            |             |Gradient colors. Example `[{ offset: 0, color: 'blue' }, {  offset: 1, color: 'red' }]`
+
+Gradient colorStops structure
+
+`options.dotsOptions.gradient.colorStops[]`
+
+`options.backgroundOptions.gradient.colorStops[]`
+
+`options.cornersSquareOptions.gradient.colorStops[]`
+
+`options.cornersDotOptions.gradient.colorStops[]`
+
+Property|Type            |Default Value|Description
+--------|----------------|-------------|-----------------------------------
+offset  |number (`0 - 1`)|             |Position of color in gradient range
+color   |string          |             |Color of stop in gradient range
+
+#### QRCodeStyling methods
+`QRCodeStyling.append(container) => void`
+
+Param    |Type       |Description
+---------|-----------|-----------
+container|DOM element|This container will be used for appending of the QR code
+
+`QRCodeStyling.serialize() => Promise<string>`
+
+`QRCodeStyling.update(options) => void`
+
+Param  |Type  |Description
+-------|------|--------------------------------------
+options|object|The same options as for initialization
+
+`QRCodeStyling.applyExtension(extension) => void`
+
+Param    |Type                  |Description
+---------|----------------------|------------------------------------------------------------------------------------------
+extension|(svg, options) => void|Extension is a function that takes svg and previously applied options and modifies an svg
+
+`applyExtension` example
+
+```JS
+const extension = (svg, options) => {
+    const { width, height } = options;
+    const size = Math.min(width, height);
+    const border = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+    const borderAttributes = {
+        "fill": "none",
+        "x": (width - size + 40) / 2,
+        "y": (height - size + 40) / 2,
+        "width": size - 40,
+        "height": size - 40,
+        "stroke": 'black',
+        "stroke-width": 40,
+        "rx": 100,
+    };
+    Object.keys(borderAttributes).forEach(attribute => {
+      border.setAttribute(attribute, borderAttributes[attribute]);
+    });
+    svg.appendChild(border);
+};
+```
+
+`QRCodeStyling.deleteExtension() => void`
+
+
+### License
+
+[MIT License](https://raw.githubusercontent.com/kozakdenys/qr-code-styling/master/LICENSE). Copyright (c) 2021 Denys Kozak
+

package/lib/constants/errorCorrectionPercents.d.ts

@@ -0,0 +1,6 @@
+export declare const ErrorCorrectionPercents: {
+    L: number;
+    M: number;
+    Q: number;
+    H: number;
+};

package/lib/core/QRCodeStyling.d.ts

@@ -0,0 +1,19 @@
+import { ExtensionFunction, Options, QRCode } from "../types";
+import { RequiredOptions } from "./QROptions";
+export declare class QRCodeStyling {
+    _options: RequiredOptions;
+    _container?: HTMLElement;
+    _svg?: SVGElement;
+    _qr?: QRCode;
+    _extension?: ExtensionFunction;
+    _svgDrawingPromise?: Promise<void>;
+    constructor(options?: Partial<Options>);
+    static _clearContainer(container?: HTMLElement): void;
+    _setupSvg(): void;
+    _getElement(): Promise<SVGElement | undefined>;
+    update(options?: Partial<Options>): void;
+    append(container?: HTMLElement): void;
+    applyExtension(extension: ExtensionFunction): void;
+    deleteExtension(): void;
+    serialize(): Promise<string | undefined>;
+}

package/lib/core/QROptions.d.ts

@@ -0,0 +1,26 @@
+import { DotType, ErrorCorrectionLevel, Gradient, Mode, Options, ShapeType, TypeNumber } from "../types";
+export interface RequiredOptions extends Options {
+    document: Document;
+    shape: ShapeType;
+    width: number;
+    height: number;
+    margin: number;
+    data: string;
+    qrOptions: {
+        typeNumber: TypeNumber;
+        mode?: Mode;
+        errorCorrectionLevel: ErrorCorrectionLevel;
+    };
+    imageOptions: {
+        hideBackgroundDots: boolean;
+        imageSize: number;
+        crossOrigin?: string;
+        margin: number;
+    };
+    dotsOptions: {
+        type: DotType;
+        color: string;
+        gradient?: Gradient;
+    };
+}
+export declare const defaultOptions: RequiredOptions;

package/lib/core/QRSVG.d.ts

@@ -0,0 +1,38 @@
+import { FilterFunction, Gradient, QRCode } from "../types";
+import { RequiredOptions } from "./QROptions";
+export declare class QRSVG {
+    _element: SVGElement;
+    _defs: SVGElement;
+    _backgroundClipPath?: SVGElement;
+    _dotsClipPath?: SVGElement;
+    _cornersSquareClipPath?: SVGElement;
+    _cornersDotClipPath?: SVGElement;
+    _options: RequiredOptions;
+    _qr?: QRCode;
+    _document: Document;
+    private _imageTools;
+    constructor(options: RequiredOptions);
+    get width(): number;
+    get height(): number;
+    getElement(): SVGElement;
+    drawQR(qr: QRCode): Promise<void>;
+    drawBackground(): void;
+    drawDots(filter?: FilterFunction): void;
+    drawCorners(): void;
+    drawImage({ width, height, count, dotSize }: {
+        width: number;
+        height: number;
+        count: number;
+        dotSize: number;
+    }): Promise<void>;
+    _createColor({ options, color, additionalRotation, x, y, height, width, name }: {
+        options?: Gradient;
+        color?: string;
+        additionalRotation: number;
+        x: number;
+        y: number;
+        height: number;
+        width: number;
+        name: string;
+    }): void;
+}

package/lib/figures/cornerDot/QRCornerDot.d.ts

@@ -0,0 +1,18 @@
+import { CornerDotType, RotateFigureArgs, BasicFigureDrawArgs, DrawArgs } from "../../types";
+export declare class QRCornerDot {
+    _element?: SVGElement;
+    _svg: SVGElement;
+    _type: CornerDotType;
+    _document: Document;
+    constructor({ svg, type, document }: {
+        svg: SVGElement;
+        type: CornerDotType;
+        document: Document;
+    });
+    draw(x: number, y: number, size: number, rotation: number): void;
+    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
+    _basicDot(args: BasicFigureDrawArgs): void;
+    _basicSquare(args: BasicFigureDrawArgs): void;
+    _drawDot({ x, y, size, rotation }: DrawArgs): void;
+    _drawSquare({ x, y, size, rotation }: DrawArgs): void;
+}

package/lib/figures/cornerSquare/QRCornerSquare.d.ts

@@ -0,0 +1,20 @@
+import { CornerSquareType, DrawArgs, BasicFigureDrawArgs, RotateFigureArgs } from "../../types";
+export declare class QRCornerSquare {
+    _element?: SVGElement;
+    _svg: SVGElement;
+    _type: CornerSquareType;
+    _document: Document;
+    constructor({ svg, type, document }: {
+        svg: SVGElement;
+        type: CornerSquareType;
+        document: Document;
+    });
+    draw(x: number, y: number, size: number, rotation: number): void;
+    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
+    _basicDot(args: BasicFigureDrawArgs): void;
+    _basicSquare(args: BasicFigureDrawArgs): void;
+    _basicExtraRounded(args: BasicFigureDrawArgs): void;
+    _drawDot({ x, y, size, rotation }: DrawArgs): void;
+    _drawSquare({ x, y, size, rotation }: DrawArgs): void;
+    _drawExtraRounded({ x, y, size, rotation }: DrawArgs): void;
+}

package/lib/figures/dot/QRDot.d.ts

@@ -0,0 +1,26 @@
+import { DotType, GetNeighbor, DrawArgs, BasicFigureDrawArgs, RotateFigureArgs } from "../../types";
+export declare class QRDot {
+    _element?: SVGElement;
+    _svg: SVGElement;
+    _type: DotType;
+    _document: Document;
+    constructor({ svg, type, document }: {
+        svg: SVGElement;
+        type: DotType;
+        document: Document;
+    });
+    draw(x: number, y: number, size: number, getNeighbor: GetNeighbor): void;
+    _rotateFigure({ x, y, size, rotation, draw }: RotateFigureArgs): void;
+    _basicDot(args: BasicFigureDrawArgs): void;
+    _basicSquare(args: BasicFigureDrawArgs): void;
+    _basicSideRounded(args: BasicFigureDrawArgs): void;
+    _basicCornerRounded(args: BasicFigureDrawArgs): void;
+    _basicCornerExtraRounded(args: BasicFigureDrawArgs): void;
+    _basicCornersRounded(args: BasicFigureDrawArgs): void;
+    _drawDot({ x, y, size }: DrawArgs): void;
+    _drawSquare({ x, y, size }: DrawArgs): void;
+    _drawRounded({ x, y, size, getNeighbor }: DrawArgs): void;
+    _drawExtraRounded({ x, y, size, getNeighbor }: DrawArgs): void;
+    _drawClassy({ x, y, size, getNeighbor }: DrawArgs): void;
+    _drawClassyRounded({ x, y, size, getNeighbor }: DrawArgs): void;
+}

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+import { ErrorCorrectionPercents } from "./constants/errorCorrectionPercents";
+import { QRCodeStyling } from "./core/QRCodeStyling";
+import * as browserUtils from "./tools/browserUtils";
+import * as types from "./types";
+export * from "./tools/browserUtils";
+export * from "./types";
+export { ErrorCorrectionPercents, QRCodeStyling };
+declare const _default: {
+    QRCodeStyling: typeof QRCodeStyling;
+    browserUtils: typeof browserUtils;
+    types: typeof types;
+};
+export default _default;

package/lib/node.d.ts

@@ -0,0 +1,7 @@
+import { RequiredOptions } from "./core/QROptions";
+import { QRCodeStyling as _QRCodeStyling } from "./index";
+export { ErrorCorrectionPercents } from "./constants/errorCorrectionPercents";
+export * from "./types";
+export declare class QRCodeStyling extends _QRCodeStyling {
+    constructor(options: RequiredOptions);
+}