useSharePointDocumentManager

@spartanfx/react v1.2.2

---

@spartanfx/react / spfx / useSharePointDocumentManager

Function: useSharePointDocumentManager()

function useSharePointDocumentManager(config): ISharePointDocumentManagerReturn;

Hook for managing SharePoint documents

Configuration

Required

Property	Type	Description
libraryName	string	Name of the SharePoint library
sp	SPFI	PnPjs SPFI instance (required)

Options

Property	Type	Description
autoRefresh?	boolean	Enable auto-refresh on mutations (default: true)
cacheDuration?	number	Cache duration in milliseconds (default: 60000 - 1 minute)
rootFolderPath?	string	Root folder path (optional) If not provided, the hook will automatically fetch the library's server-relative URL from SharePoint (e.g., '/sites/mysite/Shared Documents').

Events & callbacks

Property	Type	Description
onAfterUpload?	(file, item) => void | Promise<void>	Callback after successful upload
onBeforeUpload?	(file) => Promise<boolean | void>	Callback before upload
onError?	(error) => void	Callback on error

Full type reference: ISharePointDocumentManagerConfig

Returns

ISharePointDocumentManagerReturn

Example

const {
  items,
  loading,
  uploadFiles,
  deleteItems,
  refresh
} = useSharePointDocumentManager({
  sp: spInstance,
  libraryName: 'Documents',
  rootFolderPath: '/sites/mysite/Shared Documents'
});