SchedulerHeaderProps

Props passed to custom header renderers in the scheduler, enabling full header bar customization. Provides pre-configured button instances, templates, and configuration objects for comprehensive header control. Enables developers to customize, extend, or completely replace the default scheduler header with custom implementations.

Props

The following table outlines the props for the SchedulerHeaderProps:

NameTypeDefaultDescription
children
node
-

Custom toolbar items.

  • If only children are provided → replaces toolbar.
  • If combined with button props → extends toolbar.
dateRange
node
-

A fully configured date range button instance ready for rendering. Can be repositioned within the toolbar or excluded from display as needed.

dateRangeProps
DateRangeButtonProps | null
-

Configuration object for the date range button in the scheduler header. Set to null to completely hide the button from the toolbar.

dateRangeTemplate
(props: DateRangeProps) => node
-

Provides a custom React component to render the date range display in the scheduler header. Enables custom date range formatting or localization.

next
node
-

A fully configured "Next" navigation button instance ready for rendering. Can be repositioned within the toolbar or excluded from display as needed.

nextProps
ToolbarButtonProps | null
-

Configuration object for the "Next" navigation button in the scheduler header. Set to null to completely hide the button from the toolbar.

overflowMode
OverflowMode
-

Configures how toolbar items are displayed when space is limited: Popup, Dropdown, or Scroll. Defaults to Popup mode for optimal space management.

previous
node
-

A fully configured "Previous" navigation button instance ready for rendering. Can be repositioned within the toolbar or excluded from display as needed.

previousProps
ToolbarButtonProps | null
-

Configuration object for the "Previous" navigation button in the scheduler header. Set to null to completely hide the button from the toolbar.

today
node
-

A fully configured "Today" button instance ready for rendering. Can be repositioned within the toolbar or excluded from display as needed.

todayProps
ToolbarButtonProps | null
-

Configuration object for the "Today" button in the scheduler header. Set to null to completely hide the button from the toolbar.

viewSwitcher
node
-

A fully configured view switcher instance ready for rendering. Can be repositioned within the toolbar or excluded from display as needed.

viewSwitcherProps
ViewButtonProps | null
-

Configuration object for the view switcher button in the scheduler header. Set to null to completely hide the button from the toolbar.