gengchao123 / vue-qrcode

QR code component for Vue.js

vue-qrcode

QR code component for Vue.js, bases on node-qrcode.

• Website

Table of contents

• Main
• Getting started
• Props
• Browser support
• Versioning
• License

Main

dist/
├── vue-qrcode.js        (UMD)
├── vue-qrcode.min.js    (UMD, compressed)
├── vue-qrcode.common.js (CommonJS)
└── vue-qrcode.esm.js    (ES Module)

Getting started

Install

npm install @chenfengyuan/vue-qrcode vue

In browser:

<script src="/path/to/vue.js"></script>
<script src="/path/to/vue-qrcode.js"></script>
<script>Vue.component(VueQrcode.name, VueQrcode);</script>

Usage

import Vue from 'vue';
import VueQrcode from '@chenfengyuan/vue-qrcode';

Vue.component(VueQrcode.name, VueQrcode);

<qrcode value="Hello, World!" :options="{ width: 200 }"></qrcode>

⬆ back to top

Props

value

• Type: String
• Default: undefined

The value of the QR code.

options

• Type: Object
• Default: undefined

The options for the QR code generator. References the node-qrcode's options.

tag

• Type: String
• Default: 'canvas'
• Options: 'canvas', 'img' and other element tags.

The tag name of the component's root element.

Browser support

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Opera (latest)
• Edge (latest)
• Internet Explorer 9+

Versioning

Maintained under the Semantic Versioning guidelines.

License

MIT © Chen Fengyuan

⬆ back to top