Scheduler - API
Generated reference for Scheduler props, events, methods, slots, and types.
#Import
import { Scheduler } from '@primeui/vue-scheduler';#Timeline cell dates
Timed leaf cells in timelineDay, timelineWeek, resourceTimelineDay and
resourceTimelineWeek expose real instants. Their boundaries follow
displayTimezone (or the resolved local/scheduler timezone). A display DST day
can contain 23 or 25 hourly cells. The two fall-back hours have different Date
values and accessible names include their UTC offsets. Format these values with
the display timezone; do not read host-local getHours() to obtain the label.
Day cells in month timelines, month cells in Timeline Year, and grouped day/month
header tiers remain wall-calendar dates. Root date, date-range endpoints,
and prev/next/today/gotoDate inputs retain their wall-calendar meaning.
Month event geometry still covers whole days.
The distinction applies to Scheduler.TimelineHeaderCell replacement-child
props (date, startDate, endDate, and cell boundaries), the low-level
Scheduler.Timeline.HeaderCell scoped-slot payload, and Scheduler.TimelineCell
replacement-child and low-level Scheduler.Timeline.Cell slot payloads. It also
applies to cells/tiers exposed by the low-level Timeline Root, Header, HeaderRow,
Body and Lane scoped slots (cells, visibleCells,
tiers and their nested cell boundaries), and the useTimelineEngine export from
@primeui/vue-scheduler (cells, visibleCells, headerTiers,
visibleHeaderTiers). date aliases startDate.
Timeline.Body's public scrollToDate target and root navigation retain wall-calendar inputs. Internal cell focus reveals use instant coordinates without changing that navigation contract.
Cell-derived dateClick.date, dateSelect.start/end, selectAllow dates and selection-change dates
use the same timed-instant/day-wall distinction. Timed startStr/endStr values
are ISO instants. Existing event start/end values remain instants. No new prop or
mode is required. Timed cell selection payloads use allDay: false with ISO
startStr/endStr for both keyboard and mouse activation. Each wrapper's public
root select() method retains its prior behavior; this note concerns cell-derived
payloads. Selection state holds those same cell Dates.
The body cell data-date attribute is the display calendar key. Timed leaf
data-start-date/data-end-date attributes identify real instants as epoch
milliseconds. Calendar header tiers retain wall-date boundaries. A header child
shared by several tiers can render the supplied label directly; formatting a
raw Date requires knowing whether that tier is timed or calendar based.
#API
The generated section below comes from the public Scheduler metadata. Use it for Scheduler.Root props, emitted events, instance methods, public interfaces, and generated style classes. Vue examples use kebab-case listener names such as @event-drop, while the generated metadata lists the same events in their typed JavaScript form.
| Need | Start here |
|---|---|
| Root props and defaults | Props table in this page |
| Emitted event payloads | Events table here, then Events Reference for grouped guidance |
| Custom child parts | Slots and Contexts |
| Styling hooks | Theming and Data Attributes |
| Accessibility expectations | Accessibility |
The API table is the contract. Feature pages add usage context, option examples, and complete demos for the same props and events.
#Related Docs
#Week-Style Timeline Window
numberOfDays?: number selects a positive integer calendar-day window for
timelineWeek and resourceTimelineWeek, starting at the selected day. It updates
live, and navigation steps by that count. Removing it (or passing an invalid
count) restores the aligned seven-day week. Filters hide dates or hours inside
the window without extending it. Month timelines retain day granularity.
See custom planning windows.