Skip to main content

useSharePointDataForm

@spartanfx/react v1.2.2

@spartanfx/react / spfx / useSharePointDataForm

Function: useSharePointDataForm()

Call Signature​

function useSharePointDataForm(): UseSharePointDataFormReturn;

SPFx SharePoint adapter hook for DataForm.

Returns​

UseSharePointDataFormReturn

Call Signature​

function useSharePointDataForm(config): UseSharePointDataFormReturn;

SPFx SharePoint adapter hook for DataForm.

Parameters​

config​

IUseSharePointDataFormConfig

Returns​

UseSharePointDataFormReturn

Configuration​

Required​

PropertyTypeDescription
spSPFI-

Options​

PropertyTypeDescription
autoRefresh?boolean-
context?WebPartContext-
disabled?boolean-
fieldInternalNames?string[]-
folderPath?string-
includeHiddenFields?boolean-
initialItem?Record<string, unknown>-
itemId?number-
labelOverrides?Record<string, string>-
listId?string-
listName?string-
mode?DataFormMode-
readonly?boolean-

Events & callbacks​

PropertyTypeDescription
onError?(error) => void-
onInit?(dataFormContext) => void | Promise<void>-
onSave?(listItem, dataFormContext) => unknown-
onSaved?(item) => void | Promise<void>-
translate?(text) => string-

Full type reference: IUseSharePointDataFormConfig