@svelte-bin/qr

render QR as child, img or canvas, optionally with logo

Installation

npm i @svelte-bin/qr

Usage

<script>
	// @ts-ignore
	import { onMount } from 'svelte';
	// @ts-ignore
	import { qrcode } from '$lib/qrAction';

	/** @type {import('@svelte-bin/qr').Options} */
	let options = {
		data: 'Hello World',
		cornersSquareOptions: {
			type: 'extra-rounded'
		},
		qrOptions: {},
		cornersDotOptions: {
			type: 'square'
		}
	};
	let color = 'black';
	// @ts-ignore
	$: options['dotsOptions'] = {
		color
	};
</script>

<h1 class="text-center my-2">Svelte QrCode Action</h1>

<h2>Fill the value:</h2>
<div class="input-group mb-4">
	<input class="form-control" bind:value={options.data} />
	<input type="color" class="form-control-color input-group-text" bind:value={color} />
</div>

<div class="card">
    <!-- this will no work -->
	<svg use:qrcode={options} /> 

    <!-- this will work -->
	<canvas use:qrcode={options} />
	<img alt="qrcode" use:qrcode={options} />
    <!-- qrcode will  append inside div element as child element -->
	<div class="card-body mx-auto" use:qrcode={options} />
</div>

Api Documentation

the action will detect automatic element is img or canvas (we decide not use svg)

options structure

Property |Type |Default Value|Description -----------------------|-------------------------|-------------|----------------------------------------------------- width |number |300 |Size of canvas height |number |300 |Size of canvas type |string ('canvas' 'svg')|canvas |The type of the element that will be rendered 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