Skip to content

createForm

Description

Creates a Form instance to be consumed as a ViewModel by the UI framework layer.

Signature

ts
interface createForm {
  (props: IFormProps): Form
}

IFormProps

PropertyDescriptionTypeDefault
valuesForm valuesObject{}
initialValuesForm default valuesObject{}
patternForm interaction patternFormPatternTypes"editable"
displayForm display modeFormDisplayTypes"visible"
hiddenUI hiddenBooleanfalse
visibleVisible/hidden (data hidden)Booleantrue
editableEditableBooleantrue
disabledDisabledBooleanfalse
readOnlyRead-onlyBooleanfalse
readPrettyRead-pretty modeBooleanfalse
effectsSide-effect logic for linkage(form:Form)=>void
validateFirstStop on the first invalid ruleBooleanfalse

Usage

ts
import { createForm } from '@silver-formily/core'

const form = createForm({
  initialValues: {
    say: 'hello',
  },
})