Skip to content

Commit

Permalink
Update.
Browse files Browse the repository at this point in the history
  • Loading branch information
lrsjng committed Nov 10, 2024
1 parent b3fd09d commit 6aca1f7
Show file tree
Hide file tree
Showing 7 changed files with 4,798 additions and 4,748 deletions.
4 changes: 0 additions & 4 deletions .eslintignore

This file was deleted.

182 changes: 0 additions & 182 deletions .eslintrc.yml

This file was deleted.

85 changes: 77 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,90 @@
# kjua

[![license][license-img]][github] [![web][web-img]][web] [![github][github-img]][github] [![npm][npm-img]][npm]
[![version][npm-v-img]][npm] [![downloads][npm-dm-img]][npm]
[![license][license-img]][github] [![github][github-img]][github] [![npm][npm-img]][npm]

Dynamically generated QR codes for modern browsers.
Uses [QR Code Generator][qrcode] (MIT).

Choose between rendering the code as `canvas`, `img` or `svg`. The generated QR code will be in the least possible version requiered to encode the content (least number of blocks). Takes care of device pixel ratio to render crisp codes on all devices. Works in all modern browsers.

<!-- See a #[a(href='latest/demo/', title='demo of the latest version') demo] to get a first impression. -->

## Usage

The syntax is simple. Use global method `kjua` to create a fresh `canvas`, `img` or `svg` element displaying the QR code and add it to your page. For example:
```js
var el = kjua({text: 'hello!'});
document.querySelector('body').appendChild(el);
```

## jQuery

A jQuery plugin is included, you can use it like
```js
$('#my_container').kjua({text: 'Hello'});
```

## Options

The available options and their default values are:
```js
{
// 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
}
```


## License
The MIT License (MIT)

Copyright (c) 2020 Lars Jung (https://larsjung.de)
Copyright (c) 2024 Lars Jung (https://larsjung.de)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -31,16 +105,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.


[web]: https://larsjung.de/kjua/
[github]: https://github.com/lrsjng/kjua
[npm]: https://www.npmjs.org/package/kjua

[license-img]: https://img.shields.io/badge/license-MIT-a0a060.svg?style=flat-square
[web-img]: https://img.shields.io/badge/web-larsjung.de/kjua-a0a060.svg?style=flat-square
[github-img]: https://img.shields.io/badge/github-lrsjng/kjua-a0a060.svg?style=flat-square
[npm-img]: https://img.shields.io/badge/npm-kjua-a0a060.svg?style=flat-square

[npm-v-img]: https://img.shields.io/npm/v/kjua.svg?style=flat-square
[npm-dm-img]: https://img.shields.io/npm/dm/kjua.svg?style=flat-square

[qrcode]: https://github.com/kazuhikoarase/qrcode-generator
4 changes: 2 additions & 2 deletions dist/kjua.min.js

Large diffs are not rendered by default.

Loading

0 comments on commit 6aca1f7

Please sign in to comment.