Scheduler

SchedulerControl

Book and plan appointments by day, week, month or timeline, per person or room.

Overview

SchedulerControl is a Blazor scheduler: a calendar where users see, add and edit appointments in day, week, month, timeline and agenda views. Use it for bookings, shift schedules and staff or room planning; resources, iCalendar repeat rules and per-appointment time zones are built in, and the Changing event lets your code refuse a clash before it is saved.

Examples

#A week of guided tours

Move through the dates, switch views, click a tour to edit it or double-click an empty slot to add one; the buttons set the slot length and the switch turns on Read-only.

Walking tourFood and drinkDay tripEveningTransfer
8:00 AM
9:00 AM
10:00 AM
11:00 AM
12:00 PM
1:00 PM
2:00 PM
3:00 PM
4:00 PM
5:00 PM
6:00 PM
7:00 PM
8:00 PM
9:00 PM
Mon 16 NovAppointments
Tue 17 NovAppointments
Wed 18 NovAppointments
Thu 19 NovAppointments
Fri 20 NovAppointments
Sat 21 NovAppointments
Sun 22 NovAppointments

Week view, date Sunday, November 22 · 7 entries in the list, 5 of them repeating.

#Changes the page refuses

Try a tour before 8:00 AM, one overlapping another of the same guide, or deleting the Belém walking tour: Changing refuses them and the editor stays open, so close it with Cancel or Escape to read why on the line below.

Walking tourFood and drinkEveningTransfer
8:00 AM
9:00 AM
10:00 AM
11:00 AM
12:00 PM
1:00 PM
2:00 PM
3:00 PM
4:00 PM
5:00 PM
6:00 PM
7:00 PM
Sun 22 NovLavender
Sun 22 NovRufus

No changes yet.

#Two time zones

A client at home in Denver plans a Lisbon trip with a guide there: the same six entries in both zones, and an edit in one pane shows in the other.

Walking tourDay tripEveningTransferCall

Guide in Lisbon · TimeZoneId="Europe/Lisbon"

DateTimeAppointmentResource
Sun 22 Nov4:00 PM – 4:30 PM
Wed 25 Nov6:30 AM – 7:30 AM
Wed 25 Nov10:00 AM – 12:30 PM
Thu 26 Nov9:00 AM – 6:00 PM
Fri 27 Nov7:30 PM – 9:30 PM
Sun 29 Nov8:00 AM – 9:00 AM

Client in Denver · TimeZoneId="America/Denver"

DateTimeAppointmentResource
Sun 22 Nov9:00 AM – 9:30 AM
Tue 24 Nov11:30 PM – 12:30 AM
Wed 25 Nov3:00 AM – 5:30 AM
Thu 26 Nov2:00 AM – 11:00 AM
Fri 27 Nov12:30 PM – 2:30 PM
Sun 29 Nov1:00 AM – 2:00 AM

How the list stores them:

  • Planning call, Sun 9:00 AM America/Denver
  • Airport meet-and-greet, Wed 6:30 AM Europe/Lisbon
  • Old town walk, Wed 10:00 AM Europe/Lisbon
  • Day trip to Sintra, Thu 9:00 AM Europe/Lisbon
  • Fado evening, Fri 7:30 PM Europe/Lisbon
  • Departure transfer, Sun 8:00 AM Europe/Lisbon

Documentation

ParameterTypeDefaultDescription
EventsIReadOnlyList<SchedulerEvent>Array.Empty<SchedulerEvent>()The appointments, each with a unique Id. Two-way with @bind-Events: the control never edits this list, and every accepted change arrives as a new list of copies. Not read once OnRead has returned rows.
OnReadFunc<SchedulerRange,CancellationToken,Task<IReadOnlyList<SchedulerEvent>>>?nullLoads appointments for a range instead of Events. Called with the visible SchedulerRange on the first render and whenever the range or time zone changes, and after Previous, Today, Next and a view change; a newer call cancels the older call's token. "Loading appointments" shows meanwhile, and an exception's message shows as an alert. After an accepted change the control keeps the edited list without calling it again.
ResourcesIReadOnlyList<SchedulerResource>Array.Empty<SchedulerResource>()People or rooms. Day, Week, WorkWeek and MultiDay give each day one column per resource, headed with its Text, with its Color on the left edge of the timed appointments; Timeline gives each a row; Agenda prints the name; the editor offers them in a drop-down. When set, time views and Timeline show only appointments whose ResourceId matches one; Month and Agenda show all. Empty means one column or row headed "Appointments".
DateDateTimeDateTime.TodayA date inside the period to show. Week and WorkWeek start at the beginning of its week, Month at the beginning of the week holding the 1st of its month; the other views start on it. Two-way with @bind-Date: Previous, Today and Next change it.
ViewSchedulerViewSchedulerView.WeekThe layout; see SchedulerView. Two-way with @bind-View: the toolbar's drop-down changes it.
TimeZoneIdstring"UTC"The zone times are shown in; each appointment is converted from its own TimeZoneId. The editor fills this zone into new and edited appointments (the field can be changed), except that choosing Entire series keeps the series' zone. Any id TimeZoneInfo.FindSystemTimeZoneById accepts.
FirstDayOfWeekDayOfWeekDayOfWeek.MondayFirst column of Week and WorkWeek, and of each row in Month.
MultiDayCountint3Days shown by MultiDay, from Date, and the step of Previous and Next in that view. 1 to 31.
StartHourint8First hour of the time grid in Day, Week, WorkWeek and MultiDay. Also the time New appointment and the Month and Timeline date buttons start a new appointment at. 0 or more and below EndHour.
EndHourint18End of the time grid, at most 24. Appointments are cut to the hours shown, and one wholly outside them is not drawn in the time views (Month and Agenda still list it).
SlotMinutesint30Height of a grid row in minutes, at one pixel per minute. A double-click on a row starts a new appointment at its start; a resize strip dropped on it sets the end there. 5 to 120.
ReadOnlyboolfalseDisables New appointment and the Month date buttons, ignores clicks on appointments and double-clicks on slots, and removes the resize strips. Previous, Today, Next and the view drop-down still work.
Heightstring"600px"CSS height of the scrolling area under the toolbar.
Enabled (base)booltruefalse has the same effect as ReadOnly.
CssClass / Style (base)string?nullOn the fx-scheduler root element.
Visible (base)booltruefalse hides the root element with display:none.

Id, Title, Tag, Data, Parent and unmatched attributes, also from FlexControlBase, are not applied to any element. The editor and the delete confirmation render after the root element, not inside it. A StartHour, EndHour, SlotMinutes or MultiDayCount outside its range throws ArgumentException ("Invalid scheduler slot settings.") when parameters are set.

An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.