# weapp-qrcode

**Repository Path**: wxu12/weapp-qrcode

## Basic Information

- **Project Name**: weapp-qrcode
- **Description**: weapp.qrcode.js 在 微信小程序 中，快速生成二维码
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2020-03-22
- **Last Updated**: 2025-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# weapp-qrcode
weapp.qrcode.js 在 微信小程序 中，快速生成二维码

## Usage

先在 wxml 文件中，创建绘制的 `canvas`，并定义好 `width`, `height`, `canvasId` 。

```html
<canvas style="width: 200px; height: 200px;" canvas-id="myQrcode"></canvas>
```

直接引入 js 文件，使用 `drawQrcode()` 绘制二维码。!!!在 调用 `drawQrcode()` 方法之前，一定要确保可以获取到 `canvas context` 。

在 v0.6.0 版本构建出多个文件，详情移步[Build Files说明](https://github.com/yingye/weapp-qrcode/blob/master/dist/README.md)。

```js
// 将 dist 目录下，weapp.qrcode.esm.js 复制到项目目录中
import drawQrcode from '../../utils/weapp.qrcode.esm.js'

drawQrcode({
  width: 200,
  height: 200,
  canvasId: 'myQrcode',
  text: 'https://github.com/yingye'
})
```

如果项目使用了 wepy 框架，可直接安装 `weapp-qrcode` npm包。

```
npm install weapp-qrcode --save
```

```js
import drawQrcode from 'weapp-qrcode'

drawQrcode({
  width: 200,
  height: 200,
  canvasId: 'myQrcode',
  text: 'https://github.com/yingye'
})
```

## DEMO

![demo-img](./examples/demo.jpg)

## API

### drawQrcode([options])

#### options

Type: Object

| 参数 | 说明 | 示例|
| ------ | ------ | ------ |
| width | 必须，二维码宽度，与`canvas`的`width`保持一致 | 200 |
| height | 必须，二维码高度，与`canvas`的`height`保持一致 | 200 |
| canvasId | 必须，绘制的`canvasId` | 'myQrcode' |
| text | 必须，二维码内容 | 'https://github.com/yingye' |
| typeNumber | 非必须，二维码的计算模式，默认值-1 | 8 |
| correctLevel | 非必须，二维码纠错级别，默认值为高级，取值：`{ L: 1, M: 0, Q: 3, H: 2 }` | 1 |
| background | 非必须，二维码背景颜色，默认值白色 | '#ffffff' |
| foreground | 非必须，二维码前景色，默认值黑色 | '#000000' |
| _this | 非必须，若在组件中使用，需要传入，v0.7.0版本支持 | this |
| callback | 非必须，绘制完成后的回调函数，v0.8.0版本支持 | `function (e) { console.log('e', e) }` |

## TIPS

weapp.qrcode.js 二维码生成部分借鉴了 jquery-qrcode 源码，可以参考 [jquery-qrcode](https://github.com/jeromeetienne/jquery-qrcode)。