@plattar/plattar-qrcode
Version:
Allows embedding Plattar-Style QR Codes for existing websites.
54 lines (36 loc) • 2.02 kB
Markdown
<h3 align="center">
<img src="graphics/logo.png?raw=true" alt="Plattar Logo" width="600">
</h3>
[](https://packagephobia.com/result?p=@plattar/plattar-qrcode)
[](https://bundlephobia.com/result?p=@plattar/plattar-qrcode)
[](https://bundlephobia.com/result?p=@plattar/plattar-qrcode)
[](https://www.npmjs.com/package/@plattar/plattar-qrcode)
[](https://www.npmjs.com/package/@plattar/plattar-qrcode)
_plattar-qrcode_ allows embedding plattar style QR Codes into existing websites.
### _Quick Use_
- ES2015 & ES2019 Builds via [jsDelivr](https://www.jsdelivr.com/)
```javascript
// Minified Version ES2015 & ES2019 (Latest)
https://cdn.jsdelivr.net/npm/@plattar/plattar-qrcode/build/es2015/plattar-qrcode.min.js
https://cdn.jsdelivr.net/npm/@plattar/plattar-qrcode/build/es2019/plattar-qrcode.min.js
// Standard Version ES2015 & ES2019 (Latest)
https://cdn.jsdelivr.net/npm/@plattar/plattar-qrcode/build/es2015/plattar-qrcode.js
https://cdn.jsdelivr.net/npm/@plattar/plattar-qrcode/build/es2019/plattar-qrcode.js
```
### _Installation_
- Install using [npm](https://www.npmjs.com/package/@plattar/plattar-qrcode)
```console
npm install @plattar/plattar-qrcode
```
### _Examples_
Embed a Plattar Styled QRCode into your website
```html
<plattar-qrcode url="https://www.plattar.com" width="256" height="256" margin="0" color="#101721"></plattar-qrcode>
```
Will output the following QRCode
<h3 align="left">
<img src="graphics/plattar-qrcode.png?raw=true" alt="Plattar-QRCode" width="256">
</h3>
### _Acknowledgements_
This tool relies on the following open source projects.
- [kozakdenys qr-code-styling](https://github.com/kozakdenys/qr-code-styling)