useSharePointPlanner

@spartanfx/react v1.1.0

---

@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.

Parameters

config

ISharePointPlannerConfig

SharePoint configuration

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}
  />
);