ISaveListFormConfiguration

@spartanfx/react v1.2.2

---

@spartanfx/react / spfx / ISaveListFormConfiguration

Interface: ISaveListFormConfiguration<PreSaveResult>

Configuration options for the SaveListForm function, allowing complete control over the SharePoint list form save pipeline.

Type Parameters

PreSaveResult

PreSaveResult

The optional result from onPreSave, passed to later steps.

Properties

Required

Property	Type	Description
listFormContext	IListFormContext	The list form context providing form state, validation, and list saving logic.

Options

Property	Type	Description
folderPath?	string	Optional target folder path for saving the list item.
forceOverrideConcurrentSave?	boolean	If true, forces the list item to be saved even if concurrent updates are detected.
skipValidation?	boolean	If true, bypasses the default validation step.

Events & callbacks

Property	Type	Description
getListItemUpdates?	(listItem, preSaveResult?) => any	Optional transformation function that returns additional updates to merge into the final list item before saving.
onError?	(error) => void	Optional error handler for any unhandled exceptions during the save process.
onLoadingChanged?	(visible) => void	Optional loading handler to show or hide a spinner or overlay.
onPreSave?	(listItem) => PreSaveResult | Promise<PreSaveResult>	Callback executed before saving the list item. Can return additional data that is passed through the pipeline.
onSaveListItem?	(listItem, preSaveResult?) => Promise<IListItem>	Custom save function to override the default saveListItem logic.
onSaveSucceeded?	(savedListItem, preSaveResult?) => void | Promise<void>	Callback invoked after the list item and attachments are successfully saved.
onValidate?	(listItem) => boolean	Optional callback to perform custom validation logic. Return false to prevent saving.