Numable 创作文档同一份内容也在终端里:`numable docs <主题>`English

form-fields —— 表单字段类型与属性全表(自动生成)

这张表直接来自表单 SDK 的属性目录:运行时真读的每一个属性都在这里,「说明」列就是它的含义。怎么用、怎么校验、怎么接取数,见 numable docs params;不在本表里的属性写了不生效,也不报错。

字段类型

type 名称 用途 默认值 属性
textInput 文本输入 自由文本录入 "" placeholder maxLength maxLines pattern errorMessage
numberInput 数字输入 带范围和步进的数字字段 "" min max step decimal
datePicker 日期选择 日期字符串选择 "" format min max
timePicker 时间选择 返回 HH:mm "" (无属性)
colorPicker 颜色选择 预设色和自定义颜色 "#1677FF" recommended items
progressBar 进度条 滑动选择数值 "0" min max step decimal
switch 开关 布尔值切换 "false" (无属性)
radio 单选 单选项列表 "" items
checkBox 多选框 多选项列表 [] items minCount maxCount
select 列表选择 下拉或多选列表 "" items minCount maxCount
imageSelect 图片上传 上传一张或多张图片 [] imageAccept maxCount compress
searchSelect 搜索选择 支持本地和远程搜索 "" placeholder items dataSource
cascader 静态级联 静态层级结构选择 "" items minCount maxCount
dynamicCascader 动态级联 按层异步加载节点 "" dataSource initialItems minCount maxCount

textInput

属性 名称 类型 / 取值 缺省 说明
placeholder 占位提示 串 请输入内容 空着时显示的灰字。
maxLength 最多几个字 个数(写成串) — 字符数上限。只在提交时校验,不是「打不进去更多字」。
maxLines 最多几行 个数(写成串) — 按换行数算的行数上限,提交时校验。
pattern 格式校验 串 — 正则。两种写法都行:裸表达式 ^\d{6}$,或带修饰符的 /^abc$/i。空值直接放行 —— 它只管填了的对不对,必填要另写 required。⚠️ 正则写坏了不报错,而是判成不匹配,现象是「怎么填都过不去」。
errorMessage 校验失败的提示 串 — 格式不对时显示这句;不写就用平台自带的「格式不正确」。

numberInput

属性 名称 类型 / 取值 缺省 说明
min 最小值 数字(写成串) 0 闭区间,取得到。
max 最大值 数字(写成串) — 闭区间,取得到。不写就不设上限。
step 步进 数字(写成串) 1 加减按钮一次走多少。
decimal 小数位上限 个数(写成串) — 提交时校验小数位数;"0" = 只收整数。

datePicker

属性 名称 类型 / 取值 缺省 说明
format 日期格式 串 YYYY-MM-DD 值按这个样子存成串。
min 最早可选 串 — 按本字段的 format 解析,所以要写成和它一样的样子。
max 最晚可选 串 — 同上,按本字段的 format 写。

colorPicker

属性 名称 类型 / 取值 缺省 说明
recommended 推荐色 串数组 — 一排预设色块,用户仍可自定义。
items 可选色 串数组 — 写了就只能从这些里选。

progressBar

属性 名称 类型 / 取值 缺省 说明
min 最小值 数字(写成串) 0 滑杆左端。
max 最大值 数字(写成串) 100 滑杆右端。
step 步进 数字(写成串) 1 滑动的最小刻度。
decimal 小数位上限 个数(写成串) — 提交时校验小数位数。

radio

属性 名称 类型 / 取值 缺省 说明
items 选项表 选项数组 — 每项是 { label?, value, image? }:value 必填(存下来的就是它),label 是显示的字(不写就显示 value),image 给选项配一张图。

checkBox

属性 名称 类型 / 取值 缺省 说明
items 选项表 选项数组 — 每项是 { label?, value, image? }:value 必填(存下来的就是它),label 是显示的字(不写就显示 value),image 给选项配一张图。
minCount 最少选几个 个数(写成串) — 选中数量的下限,提交时校验。要「必须选一个」用它,不要用 required —— 后者只看空不空。
maxCount 最多选几个 个数(写成串) — 选中数量的上限,提交时校验。大于 1 就是多选,值也从串变成数组。

select

属性 名称 类型 / 取值 缺省 说明
items 选项表 选项数组 — 每项是 { label?, value, image? }:value 必填(存下来的就是它),label 是显示的字(不写就显示 value),image 给选项配一张图。
minCount 最少选几个 个数(写成串) — 选中数量的下限,提交时校验。要「必须选一个」用它,不要用 required —— 后者只看空不空。
maxCount 最多选几个 个数(写成串) — 选中数量的上限,提交时校验。大于 1 就是多选,值也从串变成数组。

imageSelect

属性 名称 类型 / 取值 缺省 说明
imageAccept 接受的文件类型 串 image/* 跟 HTML 的 accept 同一套写法,如 image/png,image/jpeg。
maxCount 最多几张 个数(写成串) 1 上限;大于 1 才能多选。
compress 压缩 对象 — 一个对象(键见下表)。不写就原图上传 —— 手机照片动辄几 MB,会把写回撑爆。

searchSelect

属性 名称 类型 / 取值 缺省 说明
placeholder 占位提示 串 请输入关键字 搜索框空着时的灰字。
items 选项表 选项数组 — 每项是 { label?, value, image? }:value 必填(存下来的就是它),label 是显示的字(不写就显示 value),image 给选项配一张图。
dataSource 远程搜索 串 — 填了就每次输入都去问一次流,关键字在 ${@event.keyword} 里;不填就在 items 里本地筛。

cascader

属性 名称 类型 / 取值 缺省 说明
items 层级表 选项数组 — 每项在 { label?, value, image? } 之外多两个键:children 是下一层,isLeaf 标它是不是末级。整棵树一次写全。
minCount 最少选几个 个数(写成串) — 选中数量的下限,提交时校验。要「必须选一个」用它,不要用 required —— 后者只看空不空。
maxCount 最多选几个 个数(写成串) — 选中数量的上限,提交时校验。大于 1 就是多选,值也从串变成数组。

dynamicCascader

属性 名称 类型 / 取值 缺省 说明
dataSource 逐层取数 串 — 每展开一层问一次流,已选路径在 ${@event.path}、层号在 ${@event.level}(从 0 起)。
initialItems 第一层 选项数组 — 首屏先显示的那一层,省掉一次等待。项里的 isLeaf 决定还要不要再问下一层 —— 漏了会一直往下问。
minCount 最少选几个 个数(写成串) — 选中数量的下限,提交时校验。要「必须选一个」用它,不要用 required —— 后者只看空不空。
maxCount 最多选几个 个数(写成串) — 选中数量的上限,提交时校验。大于 1 就是多选,值也从串变成数组。

imageSelect.compress 的键

属性 名称 类型 / 取值 缺省 说明
targetSizeKB 目标体积(KB) 个数(写成串) — 压到不超过这个体积为止。不写就不按体积压。
maxLongSide 长边上限(像素) 个数(写成串) — 先把长边缩到这个像素数以内再压。小于 320 按 320 算。
minQuality 最低质量 数字(写成串) 0.55 0–1 的小数。压不到目标体积时最多降到这里。
maxQuality 最高质量 数字(写成串) 0.9 0–1 的小数,从这里开始试。和最低质量写反了会自动摆正。
format 输出格式 枚举 auto / jpeg / png auto auto 按原图挑;有透明又想要小体积就配合下面的透明处理写 jpeg。
alphaPolicy 透明通道 枚举 preserve / drop preserve preserve 保留透明;drop 丢掉透明,能压得更小(截图类图片常用)。
failPolicy 压不到怎么办 枚举 use_min_quality / keep_original use_min_quality 降到最低质量仍超标时:use_min_quality 用最低质量那版,keep_original 原样上传(可能很大)。