条形码输入
介绍
barcode 输入类型是由 FormKit 发布的独立输入。它由 zxing 库提供支持，允许使用连接到您的浏览设备的摄像头扫描各种 1D 和 2D 条形码类型。
安装
warning
barcode 输入对 @zxing/library 有依赖，这个库相当大（约 100kb 缩小 + 压缩）。只有在您的项目特别需要通过连接的摄像头进行条形码扫描的功能时，才应该在您的项目中包含此输入。对于手动条形码输入，请考虑使用带有自定义验证规则的 mask 或 text 输入。
要安装 barcode 输入，将 @formkit/barcode 包添加到您的项目依赖项中。
npm install @formkit/barcode
然后，在您的 FormKit 配置文件中导入输入及其样式。然后将输入添加到您的全局 FormKit 配置中。
// formkit.config
...
import { barcode } from '@formkit/barcode'
import '@formkit/barcode/genesis'
...
const config = defaultConfig({
inputs: {
barcode
}
})
...
使用
基础
您现在可以在您的 <FormKit /> 组件中使用 barcode 输入类型。通过与条形码图标交互，您可以打开一个带有来自连接摄像头的视频流的覆盖层。您需要通过您的浏览器批准访问摄像头。
加载实时示例
自定义目标条形码
默认情况下，barcode 输入将扫描每一种支持的条形码类型。可以使用 formats 属性更改目标条形码格式的列表。在 zxing 文档 中可以看到支持的格式的完整列表。所有格式名称将以 _ 分隔符大写。所以 QR Code 变为 QR_CODE，UPC-A 变为 UPC_A，等等。
加载实时示例
属性 & 属性
| Prop | Type | 默认 | 描述 |
|---|---|---|---|
| formats | Array | [] | 一个包含可用格式的数组，格式为大写并用_分隔（例如QR_CODE），来自zxing文档中的可用集。如果没有提供formats数组，则所有可解析的代码格式都将被视为有效输入。 |
| barcode-icon | String | inline SVG code | 指定要放在barcodeIcon部分的图标。在相机界面加载时，barcodeIcon部分是隐藏的。 |
| loader-icon | String | spinner | 指定要放在loaderIcon部分的图标。在相机界面加载时，loaderIcon部分是显示的。 |
| close-icon | String | close | 指定要放在closeIcon部分的图标。 |
| 显示 通用 props | |||
| config | Object | {} | 提供给 input 的节点和此输入的任何后代节点的配置选项。 |
| delay | Number | 20 | 在调度 commit hook 前，输入值的去抖动毫秒数。 |
| dirtyBehavior | string | touched | 确定此输入的“dirty”标志设置方式。可以设置为 touched 或 compare — 默认为 touched，性能更好，但无法检测表单是否再次匹配其初始状态。 |
| errors | Array | [] | 要在此字段上显示的错误消息的字符串数组。 |
| help | String | '' | 帮助文本与输入关联的文本。 |
| id | String | input_{n} | 输入的唯一标识符。提供一个 id 还可以全局访问输入的节点。 |
| ignore | Boolean | false | 防止将输入包含在任何父级（组、列表、表单等）中。在仅用于 UI 而不是实际值的情况下非常有用。 |
| index | Number | undefined | 如果父级是列表，允许在给定索引处插入输入。如果输入的值未定义，它将继承该索引位置的值。如果它有一个值，它将在给定索引处将其插入到列表的值中。 |
| label | String | '' | 与输入关联的 label 元素的文本。 |
| name | String | input_{n} | 输入的名称，在数据对象中唯一标识。在一组字段中应该是唯一的。 |
| parent | FormKitNode | contextual | 默认情况下，父级是包装组、列表或表单，但此属性允许显式分配父级节点。 |
| prefix-icon | String | '' | 指定放置在 prefixIcon 部分的 图标。 |
| preserve | boolean | false | 在输入卸载时，在父组、列表或表单上保留输入的值。 |
| preserve-errors | boolean | false | 默认情况下，使用 setErrors 在输入上设置的错误会在输入时自动清除，将此属性设置为 true 可以保留错误，直到明确清除为止。 |
| sections-schema | Object | {} | 一个包含部分键和模式部分值的对象，其中每个模式部分应用于相应的部分。 |
| suffix-icon | String | '' | 指定放置在 suffixIcon 部分的 图标。 |
| type | String | text | 要从库中渲染的输入类型。 |
| validation | String, Array | [] | 要应用于输入的 验证 规则。 |
| validation-visibility | String | blur | 确定何时显示输入的验证失败规则。有效值为 blur、dirty 和 live。 |
| validation-label | String | {label prop} | 确定在验证错误消息中使用的标签，默认情况下，如果可用，则使用 label 属性，否则使用 name 属性。 |
| validation-rules | Object | {} | 附加的自定义验证规则，可用于验证 prop。 |
| value | Any | undefined | 为输入和/或其子元素提供初始值。不是响应式的。可以种子 整个组（表单）和列表。 |
部分
您可以通过使用该部分的"key"来定位输入的特定部分，从而可以修改该部分的类、HTML（通过:sections-schema）或内容（通过插槽)）。了解更多关于部分的信息，请点击这里。
输入
条形码
377340003030
🔄
扫描一个代码。
叠加层
✖️
📺
| Section-key | 描述 |
|---|---|
| barcodeIcon | 用于输出切换相机叠加层的条形码图标的元素。 |
| loaderIcon | 用于在相机界面加载时代替barcodeIcon显示的加载器图标的元素。 |
| dialog | 包含相机界面的对话框元素（默认为原生HTML dialog）。 |
| scannerContainer | 围绕关闭图标、视频流和装饰性扫描叠加层的包装器。 |
| closeIcon | 用于输出对话框关闭图标的元素。 |
| video | 显示已连接相机源的原生HTML video元素。 |
| overlay | 一个装饰性元素，叠加在video的一部分上，模仿扫描界面。 |
| overlayDecorators | 装饰叠加层的容器，用于框定视频源的一部分。 |
| overlayDecoratorTopLeft | 用于框定视频源一部分的装饰性元素。 |
| overlayDecoratorTopRight | 用于框定视频源一部分的装饰性元素。 |
| overlayDecoratorBottomLeft | 用于框定视频源一部分的装饰性元素。 |
| overlayDecoratorBottomRight | 用于框定视频源一部分的装饰性元素。 |
| laser | 模仿扫描激光的装饰性元素。 |
| 显示 通用 section keys | |
| outer | 最外层的包装元素。 |
| wrapper | 标签和输入周围的包装器。 |
| label | 输入的标签。 |
| prefix | 默认情况下没有输出，但允许直接在输入元素之前放置内容。 |
| prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
| inner | 实际输入元素周围的包装器。 |
| suffix | 默认情况下没有输出，但允许直接在输入元素之后放置内容。 |
| suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
| input | 输入元素本身。 |
| help | 包含帮助文本的元素。 |
| messages | 包装所有消息的容器。 |
| message | 包含消息的元素（或多个元素） - 最常见的是验证和错误消息。 |