Form 表单

Form 表单 高性能表单控件,自带数据域管理。包含数据录入、校验以及对应样式

何时使用

  • 用于创建一个实体或收集信息
  • 需要对输入的数据类型进行校验时

注意事项

  • 使用条件:小程序项目需开启 Component2 选项
  • 配合 a:for 指令使用时,推荐指定 key 值,否则可能出现异常情况
  • Form 标签的 form 属性值与其内部 FormItem 标签 的form 属性值必须相同,且全局唯一;内部的 FormItem 标签的 name 属性必须唯一。详见下方代码示例。
  • 配合组件库内的表单组件使用时候,需表单组件的 mode 属性值为 form

代码示例

基本使用

结合表单组件

表单分组

动态表单

必填展示样式

实例方法使用

属性

Form

属性类型必填默认值说明
formstring-表单 uid
initialValuesRecord<sring, any>-表单初始值
position'horizontal' | 'vertical''horizontal'布局
requiredMarkStyle'asterisk' | 'text-required' | 'text-optional''asterisk'必填选填的标记样式
classNamestring-类名

FromGroup

属性类型必填默认值说明
headerstring-FormGroup 名称
radiusbooleanfalseFormGroup 形状是否为圆角
classNamestring-类名

FormItem

属性类型必填默认值说明
formstringdefault表单 uid
namestringdefault字段 uid
labelstring-字段名称
position'horizontal' | 'vertical''horizontal'布局,优先级高于Form的position
arrowbooleanfalse表单项右侧箭头
requiredbooleanfalse是否必填,label展示必填标识
helpstring-label的解释说明
classNamestring-类名

事件

Form

事件名说明类型
onValuesChange字段更新,触发此回调( changedFields: Record<string, any>, allFields: Record<string, any> ) => void
onFinish表单提交后,触发此回调( changedFields: Record<string, any>, allFields: Record<string, any> ) => void

插槽

FormGroup

名称说明
header标题内容

FormItem

名称说明
extra表单项额外内容

实例方法

Form

事件名说明类型
getComponentIns获取组件示例,其值等同于默认的 ref 返回值() => Component
setFieldsValue设置表单字段值( formName: string, fieldsVals: Record<string, any> ) => void

样式类

Form

类名说明
amd-form整体样式
amd-form-footerfooter 样式

FormGroup

类名说明
amd-form-group-header标题样式
amd-form-group-radius圆角样式

FormItem

类名说明
amd-form-item-label标签样式
amd-form-item-field字段样式
amd-form-item-extra额外内容样式
amd-form-item-arrow箭头样式