Skip to main content

ISharePointTreeViewConfig

@spartanfx/react v1.2.2


@spartanfx/react / spfx / ISharePointTreeViewConfig

Interface: ISharePointTreeViewConfig

Configuration for useSharePointTreeView.

Properties

Required

PropertyTypeDescription
modeTreeViewHierarchyModeHierarchy model: - 'parentId' — a SharePoint list with a self-lookup column. - 'path' — a SharePoint document library (hierarchy from the file path).
spSPFIPnPjs SPFI instance.

Options

PropertyTypeDescription
camlQuery?stringFull-control CAML ViewXml, consistent with the DataTable/TaskManager/Planner SPFx adapters — its <ViewFields> define the select, <Query> the filter + sort, <RowLimit> the page size. - 'parentId' mode: runs via getItemsByCAMLQuery, replacing the default query. Include the id, label and parent-lookup fields in <ViewFields>. - 'path' mode: used as the document-library view; when omitted a Scope='RecursiveAll' view returning every folder + file is used.
fieldMapping?ISharePointTreeViewFieldMappingField mapping overrides.
listId?stringList/library id. Provide this or listName.
listName?stringList/library title. Provide this or listId.
rowLimit?numberMaximum rows to fetch. Default 5000.