diggindata/yii2-kjua

Yii2 widget to display a QRCode using the kjua library

Installs: 871

Dependents: 0

Suggesters: 0

Security: 0

Type:yii2-extension

0.0.3 2023-07-18 11:39 UTC

This package is auto-updated.

Last update: 2024-09-18 14:19:11 UTC


README

This extension provides a kjua QR Code widget for Yii framework 2.0.

The kjua library is provided by github/lrsjng.

Latest Stable Version

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist diggindata/yii2-kjua

or add

"diggindata/yii2-kjua": "@dev"

to the require section of your composer.json, then run composer update.

Usage

  1. Include the QRCode widget in a view file:
<?php
use diggindata\kjua\QrCodeWidget;
  1. Set some attributes:
<?php
$attributes = [
    'label' => 'My Label',
    'mode' => 'label',
    'fill' => 'navy',
    'text' => 'Good morning',
    'rounded' => 50,
    'ecLevel' => 'M',
    'crisp' => false,
    'mSize' => 20,
    'options'=>['style'=>'display:inline']
]; 
  1. Show the QRCode:
<?= QrCodeWidget::widget($attributes); ?>

The list of available attributes is described here: https://larsjung.de/kjua/.

On that page there is also a link to a demo page available.

Attributes List

// render method: 'canvas', 'image' or 'svg'
render: 'image',

// render pixel-perfect lines
crisp: true,

// minimum version: 1..40
minVersion: 1,

// error correction level: 'L', 'M', 'Q' or 'H'
ecLevel: 'L',

// size in pixel
size: 200,

// pixel-ratio, null for devicePixelRatio
ratio: null,

// code color
fill: '#333',

// background color
back: '#fff',

// content
text: 'no text',

// roundend corners in pc: 0..100
rounded: 0,

// quiet zone in modules
quiet: 0,

// modes: 'plain', 'label' or 'image'
mode: 'plain',

// label/image size and pos in pc: 0..100
mSize: 30,
mPosX: 50,
mPosY: 50,

// label
label: 'no label',
fontname: 'sans',
fontcolor: '#333',

// image element
image: null