@chenfengyuan/vue-qrcode
Version:
QR code component for Vue 3.
77 lines (50 loc) • 2.17 kB
Markdown
# vue-qrcode
[](https://codecov.io/gh/fengyuanchen/vue-qrcode) [](https://www.npmjs.com/package/@chenfengyuan/vue-qrcode) [](https://www.npmjs.com/package/@chenfengyuan/vue-qrcode) [](https://unpkg.com/@chenfengyuan/vue-qrcode/dist/vue-qrcode.js)
> QR code component for Vue 3, bases on [node-qrcode](https://github.com/soldair/node-qrcode). For Vue 2, check out the [`v1`](https://github.com/fengyuanchen/vue-qrcode/tree/v1) branch.
- [Docs](src/README.md)
- [Demo](https://fengyuanchen.github.io/vue-qrcode)
## Main files
```text
dist/
├── vue-qrcode.js (UMD, default)
├── vue-qrcode.min.js (UMD, compressed)
├── vue-qrcode.esm.js (ECMAScript Module)
├── vue-qrcode.esm.min.js (ECMAScript Module, compressed)
└── vue-qrcode.d.ts (TypeScript Declaration File)
```
## Getting started
### Installation
Using npm:
```shell
npm install vue@3 qrcode@1 @chenfengyuan/vue-qrcode@2
```
Using pnpm:
```shell
pnpm add vue@3 qrcode@1 @chenfengyuan/vue-qrcode@2
```
Using Yarn:
```shell
yarn add vue@3 qrcode@1 @chenfengyuan/vue-qrcode@2
```
Using CDN:
```html
<script src="https://unpkg.com/vue@3"></script><!-- Vue.js is required -->
<script src="https://unpkg.com/qrcode@1.5.0/build/qrcode.js"></script><!-- qrocde is required -->
<script src="https://unpkg.com/@chenfengyuan/vue-qrcode@2"></script>
```
### Usage
```js
import { createApp } from 'vue';
import VueQrcode from '@chenfengyuan/vue-qrcode';
const app = createApp({});
app.component(VueQrcode.name, VueQrcode);
```
```html
<vue-qrcode value="Hello, World!" :options="{ width: 200 }"></vue-qrcode>
```
## Browser support
Same as Vue 3.
## Versioning
Maintained under the [Semantic Versioning guidelines](https://semver.org/).
## License
[MIT](https://opensource.org/licenses/MIT) © [Chen Fengyuan](https://chenfengyuan.com/)