Skip to main content

Schedule

Ant Design

The Schedule component shows bookings on a timeline, with resources such as rooms, vehicles or people down the side and time across. Users click a booking to open it or an empty slot to book it.

Properties​

Property
Description
Expected Value
ResourcesThe rows of the schedule, as names such as ['Atlas', 'Cove'] or as { id, name, caption, avatar } objects. Leave it empty to make one row per resource named in the bookings.Array
BookingsThe bookings to place, such as the data from a query. Times can be ISO dates, YYYY-MM-DD HH:mm, HH:mm on the day shown, or YYYY-MM-DD for a whole day.Array
Resource field (a resource's id or name)Field in each booking that matches it to a resource, by the resource's id or name.Text. Default: room
Start fieldField in each booking that holds its start time.Text. Default: start
End fieldField in each booking that holds its end time.Text. Default: end
Title fieldField shown as each booking's title.Text. Default: title
Second line fieldField shown as a second line on each booking when there's room.Text
Status field (toned by its words)Field whose words color each booking, such as Confirmed in green, Pending in amber and Cancelled in red.Text. Default: status
Id fieldField that identifies each booking. It's read into selectedBookingId.Text. Default: id
Time acrosshours shows the hours of one day across the top; days shows a run of days.Hours, Days. Default: Hours
Date shown (empty for today)The day shown, or the first day in the days view, such as 2026-11-17. Leave it empty for today.Text
Day starts at (hour, or a time such as 09:00)First hour shown in the hours view, from 0 to 23, or a time such as 09:00.Number. Default: 8
Day ends at (hour, or a time such as 18:00)Last hour shown in the hours view, from 1 to 24, or a time such as 18:00.Number. Default: 18
Slot length (minutes)Length of each clickable empty slot in the hours view.Number. Default: 30
Days shownNumber of days shown in the days view.Number. Default: 7
Hour formatWhether times show on a 12h or a 24h clock.12h, 24h. Default: 12h
Resource column titleHeading of the resource column.Text. Default: Room
Resource column width (px)Width of the resource column.Number. Default: 168
Row height (px)Height of each resource row.Number. Default: 56
Show the current timeDraws a line at the current time.On or off. Default: On
Highlight the selected bookingHighlights the booking or slot the user clicked last.On or off. Default: On
Empty textText shown when there are no resources.Text. Default: No resources to schedule
Status colorsColors for status words, such as { "on site": "#0ea5e9" }. They override the automatic colors.Object

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On booking clickedTriggers when the user clicks a booking.
On slot clickedTriggers when the user clicks an empty slot.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.schedule1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.schedule1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.schedule1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
resourcesThe rows of the schedule, as names such as ['Atlas', 'Cove'] or as { id, name, caption, avatar } objects. Leave it empty to make one row per resource named in the bookings.{{components.schedule1.resources}}
bookingsThe bookings to place, such as the data from a query. Times can be ISO dates, YYYY-MM-DD HH:mm, HH:mm on the day shown, or YYYY-MM-DD for a whole day.{{components.schedule1.bookings}}
resourceFieldField in each booking that matches it to a resource, by the resource's id or name.{{components.schedule1.resourceField}}
startFieldField in each booking that holds its start time.{{components.schedule1.startField}}
endFieldField in each booking that holds its end time.{{components.schedule1.endField}}
titleFieldField shown as each booking's title.{{components.schedule1.titleField}}
subtitleFieldField shown as a second line on each booking when there's room.{{components.schedule1.subtitleField}}
statusFieldField whose words color each booking, such as Confirmed in green, Pending in amber and Cancelled in red.{{components.schedule1.statusField}}
idFieldField that identifies each booking. It's read into selectedBookingId.{{components.schedule1.idField}}
scalehours shows the hours of one day across the top; days shows a run of days.{{components.schedule1.scale}}
dateThe day shown, or the first day in the days view, such as 2026-11-17. Leave it empty for today.{{components.schedule1.date}}
dayStartFirst hour shown in the hours view, from 0 to 23, or a time such as 09:00.{{components.schedule1.dayStart}}
dayEndLast hour shown in the hours view, from 1 to 24, or a time such as 18:00.{{components.schedule1.dayEnd}}
slotMinutesLength of each clickable empty slot in the hours view.{{components.schedule1.slotMinutes}}
daysNumber of days shown in the days view.{{components.schedule1.days}}
hourFormatWhether times show on a 12h or a 24h clock.{{components.schedule1.hourFormat}}
resourceTitleHeading of the resource column.{{components.schedule1.resourceTitle}}
resourceWidthWidth of the resource column.{{components.schedule1.resourceWidth}}
rowHeightHeight of each resource row.{{components.schedule1.rowHeight}}
showNowLineDraws a line at the current time.{{components.schedule1.showNowLine}}
highlightSelectedHighlights the booking or slot the user clicked last.{{components.schedule1.highlightSelected}}
emptyTextText shown when there are no resources.{{components.schedule1.emptyText}}
statusColorsColors for status words, such as { "on site": "#0ea5e9" }. They override the automatic colors.{{components.schedule1.statusColors}}
selectedBookingThe data row of the booking the user clicked last, or {} after a slot is clicked.{{components.schedule1.selectedBooking}}
selectedBookingIdValue of Id field in the clicked booking.{{components.schedule1.selectedBookingId}}
selectedSlotThe empty slot the user clicked last, as { resourceId, resource, start, end, date, startTime, endTime, label }, or {} after a booking is clicked.{{components.schedule1.selectedSlot}}
isVisibleWhether the component is visible.{{components.schedule1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.schedule1.isLoading}}
isDisabledWhether the component is disabled.{{components.schedule1.isDisabled}}

Styles​

Style
Default
BackgroundTheme: Surface 1
Grid line colorTheme: Weak border
Label colorTheme: Primary text
Booking accent (bookings without a status, the selection)Theme: Brand primary
Current time line colorTheme: Error
Border radius—
Event radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.