@blackbox-vision/react-qr-reader

中文文档
5.0.0发布于 2021/08/05MITTypeScriptESM + CJS近 30 天下载 4382

从 Web相机读取 QR 代码的回放组件

中文使用文档
文档目录12 节
  1. 目录
  2. 使用大小写
  3. 兼容性
  4. 安装
  5. 国家预防机制
  6. 也门
  7. 示例使用
  8. 组件 API
  9. 浏览器支持
  10. 问题
  11. 捐款
  12. 许可证

Lib logo

反应 QR 读取器 npm version License: MIT Known Vulnerabilities

:rocket:反应QR Reader组件. 看看这个 演示。 。 。 .

目录

使用大小写

您需要从基于网页浏览器的应用程序中扫描 QR 代码的组件 .

兼容性

此组件已在以下浏览器中测试:

  • Chrome Mac OS & Android 软件
  • Firefox Mac OS和Android 游戏
  • Safari Mac OS & IOS 游戏

既然这个库里有你需要的钩子 React >= 16.8.0。 。 。 .

安装

您可以通过国家防范机制或YARN安装此库.

国家预防机制

npm i @blackbox-vision/react-qr-reader

也门

yarn add @blackbox-vision/react-qr-reader

示例使用

在读取和完成之前的步骤后,您应该能够导入库并像这个例子那样使用:

import React, { useState } from 'react';
import { QrReader } from '@blackbox-vision/react-qr-reader';

const Test = (props) => {
  const [data, setData] = useState('No result');

  return (
    <>
      <QrReader
        onResult={(result, error) => {
          if (!!result) {
            setData(result?.text);
          }

          if (!!error) {
            console.info(error);
          }
        }}
        style={{ width: '100%' }}
      />
      <p>{data}</p>
    </>
  );
};

组件 API

这个 QrReader 组件有下列道具:

属性类型默认值说明
约束介质跟踪约束{ facingMode: 'user' }指定应该使用哪个相机(如果有的话) .
报告function无扫描事件处理器
视频stringvideo视频元素的ID
扫描延迟number500QR 钩的扫描期
查看窗口组件无查看Finder 组件以渲染视频元素
类Name字符串无容器元素的类名.
容器样式对象无容器元素的样式对象.
视频相机Style对象无视频容器元素的样式对象 .
视频Style对象无视频元素的样式对象 .

浏览器支持

如果您需要支持旧浏览器, 请退出 本指南 如何使它与遗产相容

问题

请打开一个 问题 遵循其中一个问题模板。 我们将尽最大努力解决它们.

捐款

如果你想为这个项目捐款,请看 捐款 更多信息.

许可证

分发于 麻省理工学院许可证。见 自由主义 更多信息.

版本与发布记录

@blackbox-vision/react-qr-reader 共发布 31 个版本,首次发布于 2020/03/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2021/08/055 年前
4.1.12021/08/025 年前
4.1.02021/07/135 年前
4.0.12021/06/235 年前
4.0.02021/06/235 年前
3.1.02021/06/235 年前

关于 @blackbox-vision/react-qr-reader 的常见问题

@blackbox-vision/react-qr-reader 是什么?

从 Web相机读取 QR 代码的回放组件

如何安装 @blackbox-vision/react-qr-reader?

在项目目录运行 npm install @blackbox-vision/react-qr-reader,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16.8.0 || ^17.0.0)、react-dom(^16.8.0 || ^17.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@blackbox-vision/react-qr-reader 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@blackbox-vision/react-qr-reader 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@blackbox-vision/react-qr-reader 可以商用吗?

@blackbox-vision/react-qr-reader 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@blackbox-vision/react-qr-reader 的下载量有多少?

根据 npm 官方下载统计,@blackbox-vision/react-qr-reader 在 2026/10/09 – 2026/11/07 这 30 天内被下载 4,382 次,日均约 146 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@blackbox-vision/react-qr-reader 还在维护吗?

最新版本 5.0.0 发布于 2021/08/05(5 年前);至今共发布 31 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/03/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。