IUseDataFormContextConfig
@spartanfx/react / index / IUseDataFormContextConfig
Interface: IUseDataFormContextConfig<TValue, TSaveResult>
Type Parameters
TValue
TValue extends DataFormValues = DataFormValues
TSaveResult
TSaveResult = unknown
Properties
Options
| Property | Type | Description |
|---|---|---|
defaultValues? | Partial<TValue> | - |
disabled? | boolean | - |
fieldRenderers? | DataFormFieldRendererMap<TValue> | - |
fields? | IDataFormFieldInfo<TValue>[] | - |
initialized? | boolean | - |
initialValues? | TValue | - |
itemId? | DataFormKey | - |
listItem? | Record<string, unknown> | - |
loading? | boolean | - |
metadata? | Record<string, unknown> | - |
mode? | DataFormMode | - |
readonly? | boolean | - |
saving? | boolean | - |
validationSchema? | DataFormValidationSchema<TValue> | - |
validators? | DataFormValidators<TValue> | - |
Events & callbacks
| Property | Type | Description |
|---|---|---|
getField? | (fieldName) => | IDataFormFieldInfo<TValue> | Promise<IDataFormFieldInfo<TValue>> | - |
getListItem? | (dataFormContext) => unknown | - |
onChange? | (values, context) => void | - |
onInit? | (dataFormContext) => void | Promise<void> | - |
onSave? | (listItem, dataFormContext) => TSaveResult | Promise<TSaveResult> | - |
onSaveError? | (error, dataFormContext) => void | - |
onValidate? | (values, context) => | IDataFormValidationResult | Promise<IDataFormValidationResult> | - |
translate? | (text) => string | - |