AgendaViewProps

Configures the Agenda View for displaying events in a chronological, date-grouped list format. Agenda View is read-only and does not support drag-drop or resize interactions; it focuses on event review and navigation.

Props

The following table outlines the props for the AgendaViewProps:

NameTypeDefaultDescription
agendaDaysCount
number
7

Number of days to display in the Agenda View. Events within this date range are grouped chronologically and displayed as a scrollable list.

cell
(props: SchedulerCellProps) => node
null

Accepts a custom React component to render individual scheduler cells. Can be configured at both the root scheduler level and individual view level.

dateFormat
string
-

Applies a specific date format to all date displays in the scheduler. If not provided, the format defaults to the current culture's standard.

dateHeader
(props: SchedulerDateHeaderProps) => node
null

Accepts a custom React component to render the header cells displaying dates. Can be configured at both the root scheduler level and individual view level.

displayName
string
-

A user-friendly label for the view displayed in the view switcher. Useful when the same view type is configured with different intervals or custom settings.

editor
(props: SchedulerEditorProps) => node
null

Provides a factory function for rendering a custom editor popup; defaults to the built-in editor if not specified. View-level editor props override root-level editor when both are provided.

eventOverlap
boolean
true

Controls whether multiple events can occupy the same time slot without visual overlap adjustments. When enabled, overlapping events display side-by-side; when disabled, the scheduler prevents scheduling conflicts.

eventTemplate
(props: EventModel) => node
null

Accepts a custom React component to render events in this specific view. View-level templates override the root-level event template when both are provided.

firstDayOfWeek
number
0

Sets which day appears first in scheduler(0 = Sunday, 1 = Monday, etc.). Respects the locale's default unless explicitly overridden.

headerIndent
(props: HeaderIndentProps) => node
null

Accepts a custom React component to render the header indent area (left section of date header). When provided, replaces the default week number and all-day toggle section. Can be configured at both the root scheduler level and individual view level.

hideEmptyAgendaDays
boolean
true

Hides dates with no scheduled events in applicable views (e.g., Agenda View). When enabled, empty dates are filtered out to show only dates with events.

interval
number
1

Multiplies the view's time range by this number (e.g., interval: 2 shows 2 weeks in Week view). Useful for displaying extended periods in a single view.

name
string
-

A unique identifier for the view used in programmatic view switching. Custom names allow flexible view management without relying on standard view names.

noEventsTemplate
( ) => node
null

Custom template to display when no events are scheduled in the Agenda View. Allows users to provide a function that returns a React node for customization of the empty state.

quickInfo
null

Accepts custom React components to render different sections of the Quick Info Popup. Supports separate customization for new event creation (add) and existing event view (edit).

readOnly
boolean
false

Renders the scheduler in a non-editable state, preventing all add, edit, and delete operations. Event viewing and navigation remain fully functional.

resourceHeader
null

Accepts a custom React component to render resource header cells when grouping is enabled. Replaces the default resource name text with custom content. Can be configured at both the root scheduler level and individual view level.

showWeekNumber
boolean
false

Displays the ISO week number in the scheduler's header or date labels. Useful for tracking weeks across multiple months or years.

showWeekend
boolean
true

When set to false, it hides the weekend days of a week from the Scheduler. The days which are not defined in the working days collection are usually treated as weekend days.

timeFormat
string
-

Applies a specific time format to all time displays in the scheduler. If not provided, the format defaults to the current culture's standard.

workDays
number[]
[1, 2, 3, 4, 5]

Specifies which days of the week are considered working days. Only these days appear in the work week view; other views highlight them with a distinct style.