useCASharePointDocumentManager

@spartanfx/react v1.2.2

---

@spartanfx/react / codeapps / useCASharePointDocumentManager

Function: useCASharePointDocumentManager()

function useCASharePointDocumentManager(config): IUseCASharePointDocumentManagerReturn;

Power Apps Code Apps DocumentManager hook backed by a generated SharePoint document-library service.

The normal Code Apps path is to pass the generated service produced by pac code add-data-source directly. The hook maps the synthetic document-library fields ({IsFolder}, {Name}, {Path}, {FullPath}, etc.) into IDocumentItem and returns component-ready documentManagerProps.

A semantic file service implementing ICASharePointDocumentService is still supported for consumers that have non-tabular connector operations such as binary upload/download, copy, move, and folder creation.

Configuration

Required

Property	Type	Description
service	| ICASharePointDocumentService | ICATabularService<CADocumentRecord, string>	Generated SharePoint document-library service from pac code add-data-source, or a custom semantic file service for consumers that need non-tabular connector operations.

Options

Property	Type	Description
autoRefresh?	boolean	Enable auto-refresh after mutations (default: true).
cacheDuration?	number	Cache TTL for read results in ms (default: 60_000).
debug?	boolean	Enable verbose console logging (default: false).
fieldMapping?	ICASharePointDocumentFieldMapping	Field mapping for generated SharePoint document-library services.
libraryName?	string	Display label for the library (used in the breadcrumb).
retryPolicy?	ICARetryPolicy	Retry policy for transient failures.
rootFolderPath?	string	Server-relative root folder path for the document library (e.g. /sites/contoso/Shared Documents). Used as the initial currentPath and for breadcrumb resolution.
rowLimit?	number	Maximum records to fetch from a generated tabular service. Default: 5000.

Events & callbacks

Property	Type	Description
onAfterUpload?	(file, item) => void | Promise<void>	Called after successful upload.
onBeforeUpload?	(file) => Promise<boolean | void>	Called before upload; return false to cancel.
onError?	(error) => void	Error callback. Called for every operational failure.
onNotify?	CANotifyFn	Notification callback. If omitted, hook errors surface via error state only.

Full type reference: IUseCASharePointDocumentManagerConfig

Returns

IUseCASharePointDocumentManagerReturn

Example

const docs = useCASharePointDocumentManager({
  service: ProjectDocumentsService as never,
  libraryName: 'Project Documents',
});

return <DocumentManager {...docs.documentManagerProps} />;