Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFormFieldPropsBase<Value>

Type parameters

  • Value

Hierarchy

Index

Properties

Methods

Properties

Optional after

after: ReactNode

在表单项后面显示的自定义内容

Optional before

before: ReactNode

在表单项前面显示的自定义内容

Optional children

children: ReactNode

Optional className

className: string

Optional helpDesc

helpDesc: ReactNode

表单项说明文案

Optional label

label: ReactNode

表单项的名称

Optional modelRef

modelRef: RefObject<FieldModel<Value>>

Field 对应 model 的 ref 对象

Optional notice

notice: ReactNode

表单项警示性文案

Optional onBlur

onBlur: FocusEventHandler<Element>

Optional onCompositionEnd

onCompositionEnd: CompositionEventHandler<Element>

Optional onCompositionStart

onCompositionStart: CompositionEventHandler<Element>

Optional renderError

renderError: IRenderError<Value>

自定义错误渲染，参数是 validator 返回的对象，一次只会有一个错误

Optional required

required: string | boolean

是否必填，如果这项有值，会在校验规则里添加一个 required 规则

Optional style

style: CSSProperties

Optional touchWhen

touchWhen: TouchWhen

什么时候标记表单项为 touched

defaultvalue

TouchWhen.Change

Optional validateOccasion

validateOccasion: ValidateOccasion

什么时候触发校验

defaultvalue

ValidateOccasion.Change | ValidateOccasion.Blur

Optional withoutError

withoutError: boolean

设置不显示错误

Optional withoutLabel

withoutLabel: boolean

默认不传 label 的时候也会留有 label 的空间，使用 withoutLabel 去掉这个留空

Methods

Optional format

  • format(value: Value): Value

Optional getValidateOption

Optional normalize

  • normalize(value: Value, prevValue: Value): Value

Optional normalizeBeforeBlur

  • normalizeBeforeBlur(value: Value): Value

Optional onChange

  • onChange(e: Value): void

Generated using TypeDoc