mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-14 16:19:15 +08:00
59 lines
2.7 KiB
Markdown
59 lines
2.7 KiB
Markdown
---
|
|
category: Components
|
|
subtitle: 二维码
|
|
title: QRCode
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*cJopQrf0ncwAAAAAAAAAAAAADrJ8AQ/original
|
|
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*M4PBTZ_n9OgAAAAAAAAAAAAADrJ8AQ/original
|
|
demo:
|
|
cols: 2
|
|
group:
|
|
title: 数据展示
|
|
order: 5
|
|
---
|
|
|
|
能够将链接转换生成二维码的组件，支持自定义配色和 Logo 配置，自 `antd@5.1.0` 版本开始提供该组件。
|
|
|
|
<Alert message="若二维码无法扫码识别，可能是因为链接地址过长导致像素过于密集，可以通过 `size` 配置二维码更大，或者通过短链接服务等方式将链接变短。"></Alert>
|
|
|
|
## 何时使用
|
|
|
|
当需要将链接转换成为二维码时使用。
|
|
|
|
## 代码演示
|
|
|
|
<!-- prettier-ignore -->
|
|
<code src="./demo/base.tsx">基本使用</code>
|
|
<code src="./demo/icon.tsx">带 Icon 的例子</code>
|
|
<code src="./demo/status.tsx">不同的状态</code>
|
|
<code src="./demo/customSize.tsx">自定义尺寸</code>
|
|
<code src="./demo/customColor.tsx">自定义颜色</code>
|
|
<code src="./demo/download.tsx">下载二维码</code>
|
|
<code src="./demo/errorlevel.tsx">纠错比例</code>
|
|
<code src="./demo/Popover.tsx">高级用法</code>
|
|
|
|
## API
|
|
|
|
> 自 `antd@5.1.0` 版本开始提供该组件。
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| :-- | :-- | :-- | :-- |
|
|
| value | 扫描后的地址 | string | - |
|
|
| icon | 二维码中图片的地址（目前只支持图片地址） | string | - |
|
|
| size | 二维码大小 | number | 160 |
|
|
| iconSize | 二维码中图片的大小 | number | 40 |
|
|
| color | 二维码颜色 | string | `#000` |
|
|
| bordered | 是否有边框 | boolean | `true` |
|
|
| errorLevel | 二维码纠错等级 | `'L' \| 'M' \| 'Q' \| 'H' ` | `M` |
|
|
| status | 二维码状态 | `active \| expired \| loading ` | `active` |
|
|
| onRefresh | 点击"点击刷新"的回调 | `() => void` | - |
|
|
|
|
## FAQ
|
|
|
|
### 关于二维码纠错等级
|
|
|
|
纠错等级也叫纠错率，就是指二维码可以被遮挡后还能正常扫描，而这个能被遮挡的最大面积就是纠错率。
|
|
|
|
通常情况下二维码分为 4 个纠错级别：`L级` 可纠正约 `7%` 错误、`M级` 可纠正约 `15%` 错误、`Q级` 可纠正约 `25%` 错误、`H级` 可纠正约`30%` 错误。并不是所有位置都可以缺损，像最明显的三个角上的方框，直接影响初始定位。中间零散的部分是内容编码，可以容忍缺损。当二维码的内容编码携带信息比较少的时候，也就是链接比较短的时候，设置不同的纠错等级，生成的图片不会发生变化。
|
|
|
|
> 有关更多信息，可参阅相关资料：[https://www.qrcode.com/zh/about/error_correction](https://www.qrcode.com/zh/about/error_correction.html)
|