useSharePointPlanner

@spartanfx/react v1.2.2

---

@spartanfx/react / spfx / useSharePointPlanner

Function: useSharePointPlanner()

function useSharePointPlanner(config): UseSharePointPlannerReturn;

SharePoint adapter hook for Planner component. Returns props that can be spread directly into the Planner component.

Configuration

Required

Property	Type	Description
listName	string	SharePoint list name
schema	IPlannerSchema	Schema mapping SharePoint fields to planner fields
sp	SPFI	PnPjs SPFI instance

Options

Property	Type	Description
camlQuery?	string	Optional additional CAML query conditions (will be combined with date filter)
debounceMs?	number	Debounce delay in milliseconds for refetch operations (default: 300)
debug?	boolean	Enable debug logging (default: false)
endDate?	Date	End date for filtering items (used to build CAML query)
rowLimit?	number	Row limit per request (default: 5000)
searchText?	string	Optional search text for client-side filtering
startDate?	Date	Start date for filtering items (used to build CAML query)

Full type reference: ISharePointPlannerConfig

Returns

UseSharePointPlannerReturn

Planner props

Example

const plannerProps = useSharePointPlanner({
  sp: sp,
  listName: 'Projects',
  schema: {
    idField: { fieldName: 'Id' },
    titleField: { fieldName: 'Title' },
    startDateField: { fieldName: 'StartDate' },
    endDateField: { fieldName: 'EndDate' },
    groupField: { fieldName: 'Department' },
  },
});

return (
  <Planner
    {...plannerProps}
    viewBy={ViewBy.month}
    periodCount={PeriodCount.one}
    onPlannerDatesChanged={plannerProps.onPlannerDatesChanged}
  />
);