WeekViewProps
Configures the week view display in the React Scheduler component. Provides properties for customizing time slot layout, overlap behavior, and event rendering for seven-day week views. Inherits all scheduler common properties while supporting view-specific customizations.
Props
The following table outlines the props for the WeekViewProps:
| Name | Type | Default | Description |
|---|---|---|---|
| allowVirtualScrolling | boolean | false | Enables virtualization of resource rows in grouped timeline views and of resource columns in grouped Day, Week, WorkWeek and Month views. The flag is ignored for ungrouped views, compact group view and the Agenda view. |
| 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. |
| enableLazyLoading | boolean | false | Enables virtualization together with lazy data loading.
In grouped timeline views, requests use stable inclusive windows over flattened resource rows,
including parent rows; the window size uses |
| endHour | string | '24:00' | Specifies the end hour displayed in the scheduler view. Times after this hour are hidden from the display. Accepts time in short skeleton format (e.g., '20:00'). |
| 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. |
| group | {} | Configures the layout grouping of multiple resources. When provided, resources are organized in the scheduler layout based on names. | |
| 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. |
| headerRows | [ ] | Configures header rows displayed in Timeline views. Allows multi-level hierarchical display of Year, Month, Week, Date, and Hour. Applicable only to timeline views (TimelineDay, TimelineWeek, TimelineWorkWeek, TimelineMonth). | |
| 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. |
| lazyLoadingPageSize | number | Rendered viewport rows plus overscan | Sets the number of flattened resource rows included in each lazy-loading request bucket of the timeline views.
When omitted, the request size is based on the resource rows rendered in the viewport plus overscan.
Requests use stable adjacent windows: scrolling within a requested window does not issue another request,
and the next window is requested only after the viewport crosses the current window boundary.
Values below 10 and non-finite values (NaN, Infinity) are normalized to 10.
This value only sizes lazy-loading data requests. It is not used by |
| 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. |
| overscanCount | number | 3 | Number of resource rows (timeline views) or resource columns (Day, Week, WorkWeek and Month views) retained on each side of the viewport.
Values below three are normalized to three.
It also contributes to the page size of |
| 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 | (props: SchedulerResourceHeaderProps) => node | 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 |
| startHour | string | '00:00' | Specifies the start hour displayed in the scheduler view. Times before this hour are hidden from the display. Accepts time in short skeleton format (e.g., '08:00'). |
| 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. |
| timeScale | { enable: true, interval: 60, slotCount: 2, majorSlot: null, minorSlot: null } | Configures the time slot layout, including interval duration, number of slots per hour, and custom slot templates. Allows fine-grained control over how time is segmented and displayed in the scheduler. | |
| 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. |