Skip to main content

useDataFormContext

@spartanfx/react v1.2.2

@spartanfx/react / index / useDataFormContext

Function: useDataFormContext()

function useDataFormContext<TValue, TSaveResult>(config?): IDataFormContext<TValue, TSaveResult>;

Creates or consumes a DataForm context.

Type Parameters​

TValue​

TValue extends DataFormValues = DataFormValues

TSaveResult​

TSaveResult = unknown

Configuration​

Options​

PropertyTypeDescription
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​

PropertyTypeDescription
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-

Full type reference: IUseDataFormContextConfig

Returns​

IDataFormContext<TValue, TSaveResult>