FormField 抽象表单控件

表单控件的抽象基类。

API

FormField

参数说明类型默认值
label标签,只在 Form 下生效ReactNode
name字段名string
value<受控>当前值any
defaultValue默认值any
required是否必输booleanfalse
readOnly是否只读booleanfalse
disabled是否禁用booleanfalse
form对照表单 idstring
dataIndex对照 record 在 DataSet 中的 indexnumberds.currentIndex
record对照 record,优先级高于 dataSet 和 dataIndexRecord
multiple是否是多值booleanfalse
validator校验器,回调返回值为 truePromise.resolve(true) 为校验通过,否则为不通过(value, name, form) => string | boolean | Promise<string | boolean>
help额外信息,常用于提示string
showHelp展示提示信息的方式,tooltip 只有在 TextField 及其子类上生效, 可选值 tooltip | newLine | nonestringnewLine
renderer渲染器,覆盖默认渲染行为({ value, text, name, record, dataSet }) => ReactNode({ text }) => text
noValidate不校验,不影响 DataSet 校验booleanfalse
maxTagPlaceholder多值标签超出最大数量时的占位描述ReactNode | (restValues) => ReactNode
maxTagCount多值标签最大数量number
maxTagTextLength多值标签文案最大长度number
pristine显示原始值booleanfalse
trim字符串值是否去掉首尾空格,如果绑定 DataSet 需要在 DataSet 的 Field 上设置 trim,可选值: both | left | right | nonestringboth
format字符串格式化,可选值: uppercase | lowercase | capitalizestring
validationRenderer校验信息渲染(validationResult, validationProps) => ReactNode
onInvalid校验失败回调(validationResults, validity, name) => void
onChange值变化回调(value, oldValue, form) => void
onInput输入回调Function
onEnterDown键盘回车回调Function
onClear值清空回调Function

注意,当绑定 DataSet 时,以 DataSet 的校验为主,校验规则应设置在 DataSet 的 Field 上。

更多属性请参考 DataSetComponent

RenderParam

  1. export type RendererParam = {
  2. value?: any;
  3. text?: any;
  4. record?: Record | null;
  5. name?: string;
  6. dataSet?: DataSet | null;
  7. };