useSharePointDataTable

@spartanfx/react v1.2.2

---

@spartanfx/react / spfx / useSharePointDataTable

Function: useSharePointDataTable()

function useSharePointDataTable<T>(config): UseSharePointDataTableReturn<T>;

SharePoint adapter hook for DataTable component Provides all necessary props and handlers to connect DataTable with SharePoint lists

Type Parameters

T

T = any

Configuration

Required

Property	Type	Description
context	WebPartContext	SPFx WebPart context
listName	string	SharePoint list name
sp	SPFI	PnPjs SPFI instance

Options

Property	Type	Description
camlQuery?	string	Optional CAML query for filtering
columns?	IDataTableColumn<any>[]	Optional columns configuration
groupByLevel1?	string	Field name for level-1 grouping
groupByLevel2?	string	Field name for level-2 grouping
groupByLevel3?	string	Field name for level-3 grouping
groupsDefaultCollapsed?	boolean	Whether groups start collapsed
inPlaceSearchText?	string	Optional search text
rowLimit?	number	Row limit per request
translatedFields?	string[]	Fields that require translation of filter values

Events & callbacks

Property	Type	Description
inPlaceFilterItems?	(item) => boolean	Client-side filter function
translate?	(text) => string	Translation function

Appearance & theming

Property	Type	Description
appearance?	AppearanceMode	Appearance mode for theming (light or dark)

Full type reference: IUseSharePointDataTableConfig

Returns

UseSharePointDataTableReturn<T>

DataTable props object ready to be spread into DataTable component

Example

const dataTableProps = useSharePointDataTable({
  listName: 'Projects',
  sp: sp,
  context: context,
  columns: columns
});

return <DataTable {...dataTableProps} />;