useCASharePointPlanner

@spartanfx/react v1.1.0

---

@spartanfx/react / codeapps / useCASharePointPlanner

Function: useCASharePointPlanner()

function useCASharePointPlanner(config): ICAPlannerReturn;

Power Apps Code Apps Planner hook backed by a SharePoint list.

Consumes a generated SharePoint-list service produced by pac code add-data-source -a shared_sharepointonline -t <ListName> -d <siteUrl>.

Parameters

config

IUseCASharePointPlannerConfig

Returns

ICAPlannerReturn

Example

import { ProjectsService } from './generated/services/ProjectsService';
import { useCASharePointPlanner } from '@spartanfx/react/codeapps';

const plannerProps = useCASharePointPlanner({
  service: ProjectsService as any,
  schema: {
    idField:        { fieldName: 'ID' },
    titleField:     { fieldName: 'Title' },
    startDateField: { fieldName: 'StartDate' },
    endDateField:   { fieldName: 'EndDate' },
    groupField:     { fieldName: 'Department' },
  },
  startDate: new Date(2026, 0, 1),
  endDate:   new Date(2026, 11, 31),
});

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