@hzab/high-speed-scanner

组件模板

• [email protected]

• 注意：首次克隆先执行 npm run prepare 命令

组件

示例

import Demo from "@hzab/high-speed-scanner";

<Demo />;

API

InfoPanel Attributes

| 参数 | 类型 | 必填 | 默认值 | 说明 | | ---------------- | ---------------------------- | ---- | ------ | ------------------ | | onChange | (v: any, list?: any) => void | 是 | - | 回调 | | isShow | boolean | 否 | true | 是否显示摄像头画面 | | videoClassName | string | 否 | true | 摄像头页面类名 | | resultClassName | string | 否 | true | 结果页类名 | | onGetCombineData | (v: any)=>void | 否 | - | 获取图片合成数据 |

HighSpeedScanner ref Methods

可使用 ref 获取并触发执行

| 参数 | 类型 | 必填 | 默认值 | 说明 | | ------------ | ------------------- | ---- | ------ | ---------------- | | onScanImage | () => void | 否 | - | 手动触发拍照 | | onReadIDCard | () => void | 否 | - | 手动触发读取证件 | | combinImage | (img1,img2) => void | 否 | - | 手动触发图片合成 |

组件开发流程

• 在 config/webpack.config.js 中按需修改 library 配置的文件名
• 在 config/webpack.config.js 中按需修改 alias 配置的包名，便于本地调试
• 在 tsconfig.json 中按需修改 paths 配置的包名，解决 ts 报错问题
• npm run dev

文件目录

• example 本地开发测试代码
• src 组件源码

命令

• Mac 执行该命令，设置 pre-commit 为可执行文件

  • npm run mac-chmod
  • chmod +x .husky && chmod +x .husky/pre-commit

• 生成文档：npm run docs

• 本地运行：npm run dev

• 打包编译：npm run build

发布

• 注意：示例代码生效，但发布之后未生效。确认是否执行了编译！！！

• 编译组件：npm run build

• 命令：npm publish --access public

• 发布目录：

  • src

配置

配置文件

• 本地配置文件：config/config.js

webpack 配置文件

• config/webpack.config.js