useCATreeView
@spartanfx/react / codeapps / useCATreeView
Function: useCATreeView()
function useCATreeView(config): ICATreeViewReturn;
Shared Power Apps Code Apps hook backing the SharePoint + Dataverse TreeView adapters. Reads rows from a generated tabular service and shapes them for the TreeView (parent/child or path hierarchy).
Configuration
Required
| Property | Type | Description |
|---|---|---|
fieldMapping | ICATreeViewFieldMapping | Column mapping. |
mode | TreeViewHierarchyMode | Hierarchy model — 'parentId' (self-lookup) or 'path' (library). |
service | ICATabularService<CATreeRecord, string> | Generated tabular service from pac code add-data-source. |
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). |
odataFilter? | string | Optional OData $filter expression. |
orderColumn? | string | Optional $orderby column. |
retryPolicy? | ICARetryPolicy | Retry policy for transient failures. |
rowLimit? | number | Maximum records per fetch (default: 5000). |
Events & callbacks
| Property | Type | Description |
|---|---|---|
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:
ICATreeViewBaseConfig