Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fengyuanchen/vue-qrcode

QR code component for Vue.js
https://github.com/fengyuanchen/vue-qrcode

qr-code qrcode vue vue-component vue-qrcode vuejs

Last synced: about 1 month ago
JSON representation

QR code component for Vue.js

Awesome Lists containing this project

README

        

# vue-qrcode

[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-qrcode.svg)](https://codecov.io/gh/fengyuanchen/vue-qrcode) [![Downloads](https://img.shields.io/npm/dm/@chenfengyuan/vue-qrcode.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-qrcode) [![Version](https://img.shields.io/npm/v/@chenfengyuan/vue-qrcode.svg)](https://www.npmjs.com/package/@chenfengyuan/vue-qrcode) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/@chenfengyuan/vue-qrcode.svg)](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 npm package 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

```

### Usage

```js
import { createApp } from 'vue';
import VueQrcode from '@chenfengyuan/vue-qrcode';

const app = createApp({});

app.component(VueQrcode.name, VueQrcode);
```

```html

```

## 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/)