SchedulerGroup

Configures grouping settings for multiple resources.

Props

The following table outlines the props for the SchedulerGroup:

NameTypeDefaultDescription
byDate
boolean
false

Specifies whether dates are rendered under each resource.

byGroupID
boolean
true

Specifies whether child resources are grouped by parent groupID.

enableCompactView
boolean
false

Enables compact view mode for resource grouping. When true, the scheduler displays one resource at a time with a collapsible tree-view drawer for navigation. When false, full multi-resource columns are shown. Compact view is opt-in: it activates only when this prop is explicitly set to true.

groupEdit
boolean
false

Allows creation and editing of linked appointments assigned to multiple resources. When set to true, a single appointment object instance will be maintained in schedule dataSource that are created for multiple resources, whereas displayed individually on UI.

headerTooltipTemplate
undefined

Template option to customize the tooltip displayed over the resource header. By default, no tooltip is shown for resource headers.

  • Function: (props: SchedulerResourceHeaderProps) => ReactNode. It receives the hovered resource's resourceData (all fields mapped from the resource dataSource) and its resource configuration, so it can render data-driven content.
  • ReactNode (string, number or JSX): rendered as static content. A string is rendered as plain text and is not parsed as HTML. It has no data binding, so use the function form for dynamic content.
resources
string[]
[ ]

Specifies the resource group names in order.

selectedResource
string | number
undefined

Specifies the initially selected resource in compact view mode. Accepts either a numeric resource ID (matched against the resource's idField) or the actual string/number value stored in the resource data. If the provided value does not match any resource, the first resource in the group is selected.