init commit
This commit is contained in:
17
README.md
17
README.md
@@ -88,7 +88,7 @@ interface ScanConfigOptions {
|
||||
webScanBeepAudio?: string;
|
||||
webScanBeepEnabled?: boolean;
|
||||
initWechatJssdk?: {
|
||||
apiUrl: string;
|
||||
apiUrl?: string;
|
||||
sdkConfig?: {
|
||||
debug?: boolean;
|
||||
appId: string;
|
||||
@@ -104,6 +104,7 @@ interface ScanConfigOptions {
|
||||
|
||||
| 配置 | 说明 | 默认值 |
|
||||
| --- | --- | --- |
|
||||
| `scanRestartDelay` | 扫码重启延迟,单位:毫秒 | `500ms` |
|
||||
| `bridgeEnabled` | 是否启用桥接扫码 | `true` |
|
||||
| `bridgeName` | 挂载在 `window` 上的桥接对象名称 | `__bridge_client__` |
|
||||
| `webCanvasEnabled` | 是否显示 Web 扫码 canvas;关闭后仍会用隐藏 canvas 识别 | `true` |
|
||||
@@ -115,6 +116,20 @@ interface ScanConfigOptions {
|
||||
| `webScanBeepEnabled` | Web 扫码成功是否播放提示音 | `true` |
|
||||
| `initWechatJssdk` | 微信 JSSDK 初始化配置,仅微信环境生效 | 无 |
|
||||
|
||||
`initWechatJssdk` 子配置:
|
||||
|
||||
| 配置 | 说明 | 默认值 |
|
||||
| --- | --- | --- |
|
||||
| `apiUrl` | 微信 JSSDK 签名配置接口地址;未传 `sdkConfig` 时会请求该接口,并自动携带当前页面 URL 参数 | 无 |
|
||||
| `sdkConfig` | 直接传入微信 JSSDK 签名配置;配置后不再请求 `apiUrl` | 无 |
|
||||
| `sdkConfig.debug` | 是否开启微信 JSSDK 调试模式 | `false` |
|
||||
| `sdkConfig.appId` | 微信公众平台应用 ID | 必填 |
|
||||
| `sdkConfig.timestamp` | 签名时间戳 | 必填 |
|
||||
| `sdkConfig.nonceStr` | 签名随机字符串 | 必填 |
|
||||
| `sdkConfig.signature` | 微信 JSSDK 签名 | 必填 |
|
||||
| `sdkUrl` | 微信 JSSDK 脚本地址 | `https://res.wx.qq.com/open/js/jweixin-1.6.0.js` |
|
||||
| `jsApiList` | 微信 JSSDK JS-API 列表,SDK 会自动追加 `scanQRCode` | `["scanQRCode"]` |
|
||||
|
||||
## 桥接接入
|
||||
|
||||
桥接对象需要挂载到 `window[bridgeName]`,并实现 `call(method, data)`。
|
||||
|
||||
Reference in New Issue
Block a user