Introducing KickStart — AI generated FormKit forms in seconds. Generate from a screenshot, edit with drag-and-drop or conversational AI, copy & paste as components or schema!
Try for free
file
输入使用HTML的原生文件输入。它允许用户从他们的设备中选择文件进行上传。除了原生输入特性外,它还增加了对以下功能的支持:
file
类型的值应始终是一个对象数组,每个对象包含一个 name
(字符串)和可选的 file
(File)属性。当从用户的设备中选择新文件时,FormKit会自动将原生的 FileList
转换为所需的基于数组的结构。
这种结构可以用来预填充之前上传的文件值到文件输入中:
预填充输入文件名仅用于显示目的。这是一个可选功能,提供了一个一致的界面来传达文件是之前上传的——然而——一个FileList并没有附加到实际的<input>
标签上进行上传。
文件上传过程留给您的表单提交处理程序。当通过完整页面请求提交表单时,不需要进一步处理,但是当通过XHR/Fetch请求提交时,您需要创建一个附加了文件的FormData
实例。这里有一个工作示例:
file
输入有一些独特的属性。还有几个常用的原生HTML属性,有助于控制文件上传。
Prop | Type | 默认 | 描述 | ||
---|---|---|---|---|---|
Commonly used native attributes | |||||
accept | -- | -- | 在 MDN 上查看 | ||
capture | -- | -- | 在 MDN 上查看 | ||
multiple | -- | -- | 在 MDN 上查看 | ||
webkitdirectory | -- | -- | 在 MDN 上查看 | ||
Props | |||||
file-item-icon | String | ’’ | 指定一个图标放在fileItemIcon 部分。仅在选择了文件时显示。默认为fileDoc 图标。 | ||
file-remove-icon | String | ’’ | 指定一个图标放在fileRemoveIcon 部分。仅在选择了文件时显示。默认为close 图标。 | ||
no-files-icon | String | ’’ | 指定一个图标放在noFilesIcon 部分。仅在没有选择文件时显示。默认为fileDoc 图标。 | ||
显示 通用 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
)或内容(通过插槽))。了解更多关于部分的信息,请点击这里。
Section-key | 描述 |
---|---|
fileList | 包裹所有文件列表的容器。 |
fileItemIcon | 包含可选文件项图标的元素。 |
fileItem | 包含文件名和每个文件的移除操作的元素。 |
fileName | 包含文件名的元素。 |
fileRemove | 从列表中移除文件的元素。 |
fileRemoveIcon | 包含文件移除图标的元素。 |
noFiles | 当没有选中文件时显示的元素。 |
noFilesIcon | 在无文件区域内包含图标的元素。 |
显示 通用 section keys | |
outer | 最外层的包装元素。 |
wrapper | 标签和输入周围的包装器。 |
label | 输入的标签。 |
prefix | 默认情况下没有输出,但允许直接在输入元素之前放置内容。 |
prefixIcon | 输出在前缀部分之前放置一个图标的元素。 |
inner | 实际输入元素周围的包装器。 |
suffix | 默认情况下没有输出,但允许直接在输入元素之后放置内容。 |
suffixIcon | 输出在后缀部分之后放置一个图标的元素。 |
input | 输入元素本身。 |
help | 包含帮助文本的元素。 |
messages | 包装所有消息的容器。 |
message | 包含消息的元素(或多个元素) - 最常见的是验证和错误消息。 |
所有 FormKit 输入都是基于以下无障碍性考虑而设计的。通过在此处提交无障碍性问题,帮助我们不断提高所有人的无障碍性:
部分键 | 属性 | 默认 | 描述 |
---|---|---|---|
label | label | for | 将其与输入元素关联,提高可访问性和用户体验 |
input | input | disabled | 禁用 HTML 元素,阻止用户交互并指示非交互状态 |
aria-describedby | 通过将元素与描述关联,增强可访问性,帮助屏幕阅读器 | ||
aria-required | 当需要验证时,添加所需的状态 | ||
icon | icon | for | 每当将图标定义为标签时,将其与输入元素关联,增强可访问性和用户体验 |
键盘事件 | 描述 |
---|---|
Tab | 将焦点移动到页面上的下一个可聚焦输入。 |
Shift + Tab | 将焦点移动到页面上的上一个可聚焦输入。 |