IDataFormContext
@spartanfx/react / index / IDataFormContext
Interface: IDataFormContext<TValue, TSaveResult>
Type Parameters
TValue
TValue extends DataFormValues = DataFormValues
TSaveResult
TSaveResult = unknown
Properties
Required
| Property | Type | Description |
|---|---|---|
disabled | boolean | - |
formState | IDataFormState<TValue> | - |
getField | (fieldName) => Promise<IDataFormFieldInfo<TValue>> | - |
getFieldDefaultValue | (fieldName) => unknown | - |
getInitialValues | () => TValue | - |
getListItem | <TListItem>() => Promise<TListItem> | - |
getRegisteredFields | () => IDataFormFieldInfo<TValue>[] | - |
getText | (text) => string | - |
initialized | boolean | - |
loading | boolean | - |
mode | DataFormMode | - |
readonly | boolean | - |
registerField | (field) => void | - |
save | (options?) => Promise<unknown> | - |
saving | boolean | - |
unregisterField | (fieldName) => void | - |
validate | () => Promise<boolean> | - |
validateField | (fieldName, field?) => Promise<string[]> | - |
validation | IDataFormValidation | - |
Options
| Property | Type | Description |
|---|---|---|
error? | Error | - |
fieldRenderers? | DataFormFieldRendererMap<TValue> | - |
itemId? | DataFormKey | - |
metadata? | Record<string, unknown> | - |
Events & callbacks
| Property | Type | Description |
|---|---|---|
forceReload? | () => Promise<void> | - |