React Scheduler Default Appointment Template

This section lists the fields that are used in a default template for scheduler appointments.

Type:

Object

By default, a predefined appointment template is applied to display scheduler appointments. This template is based on certain fields of the data source provided for the widget. Below is the list of these fields. If the default appointment template is not appropriate for your task, implement a custom appointment template based on these or other fields of your data source.

See Also

allDay

Specifies whether the appointment lasts all day.

Type:

Boolean

For details on all-day appointments, refer to the Appointment Types article.

component

An alias for the template option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

description

Specifies a detail description of the appointment.

Type:

String

disabled

Specifies whether an appointment should be disabled.

Type:

Boolean

Default Value: false

endDate

Specifies the ending of the appointment.

Type:

Date

The startDate and endDate fields are used to position the rectangle representing an appointment in the scheduler.

endDateTimeZone

Specifies the timezone of the appointment end date. Applies only if timeZone is not specified.

Type:

String

By default, the appointment end date is displayed in the current timezone. To define the timezone, specify the endDateTimeZone option.

The list of supported timezones is available in the list of IANA time zones.

See Also

html

Specifies HTML code inserted into the appointment element.

Type:

String

recurrenceException

Specifies exceptions for the current recurring appointment.

Type:

String

To define an exception for a recurring appointment, specify the recurrenceException field in the appointment object. This field enables you to specify several appointments to exclude. Each appointment is specified by the start date and time. The start time of each excluded appointment should strictly match the start time of the initial appointment.

NOTE
This option makes sense only if the appointment recurrenceRule is specified.

For details on recurring appointments, refer to the Appointment Types article.

View Demo

recurrenceRule

Specifies a recurrence rule for generating recurring appointments in the scheduler.

Type:

String

To define a recurring appointment, specify the recurrenceRule field in the appointment object. This field should be set using the iCalendar RFC 2445 specification.

For details on recurring appointments, refer to the Appointment Types article.

View Demo

render

An alias for the template option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

startDate

Specifies the start of the appointment.

Type:

Date

The startDate and endDate fields are used to position the rectangle representing an appointment in the scheduler.

startDateTimeZone

Specifies the timezone of the appointment start date. Applies only if timeZone is not specified.

Type:

String

By default, the appointment start date is displayed in the current timezone. To define the timezone, specify the startDateTimeZone option.

The list of supported timezones is available in the list of IANA time zones.

See Also

template

Specifies an appointment template that should be used to render this appointment only.

Type:

template

Template Data: undefined

Whether you use a default or a custom template for appointments, you can specify a specific template for a particular appointment. To do so, set the template field for the data source object of this appointment. The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies the subject of the appointment.

Type:

String

The subject will present the appointment in a timetable.

visible

Specifies whether or not an appointment must be displayed.

Type:

Boolean

Default Value: true