AppointmentForm Plugin Reference

The AppointmentForm plugin renders a form that visualizes appointment’s data and allows a user to modify this data.

Import

Use the following statement to import a plugin with embedded theme components:

import { AppointmentForm } from '@devexpress/dx-react-scheduler-material-ui';

You can import the themeless plugin if you want to use custom components:

import { AppointmentForm } from '@devexpress/dx-react-scheduler';

User reference

Dependencies

Properties

Name Type Default Description
visible? boolean   Specifies the appointment form’s visibility.
onVisibilityChange? (visible: boolean) => void   Handles changes to the appointment form’s visibility.
appointmentData? AppointmentModel   Specifies the appointment’s data that the form displays.
onAppointmentDataChange? (appointmentData: AppointmentModel) => void   Handles changes to the appointment’s data.
readOnly? boolean false Specifies the appointment form is read-only.
popupComponent ComponentType<AppointmentForm.PopupProps>   A component that renders the appointment form’s popup.
containerComponent ComponentType<AppointmentForm.ContainerProps>   A component that renders the appointment form’s container.
scrollableAreaComponent ComponentType<AppointmentForm.ScrollableAreaProps>   A component that renders the appointment form’s scrollable area.
staticAreaComponent ComponentType<AppointmentForm.StaticAreaProps>   A component that renders the appointment form’s static area.
messages? AppointmentForm.LocalizationMessages   An object that specifies localization messages.

Interfaces

AppointmentForm.PopupProps

Properties passed to a component that renders the appointment form’s popup.

Field Type Description
visible? boolean Specifies whether the popup is visible.
children ReactNode A React node used to render the popup content.

AppointmentForm.ContainerProps

Properties passed to a component that renders the appointment form’s container.

Field Type Description
children ReactNode A React node used to render the container content.

AppointmentForm.ScrollableAreaProps

Properties passed to a component that renders the appointment form’s scrollable area.

Field Type Description
children ReactNode A React node used to render the scrollable area content.

AppointmentForm.StaticAreaProps

Properties passed to a component that renders the appointment form’s static area.

Field Type Description
children ReactNode A React node used to render the static area content.

Localization Messages

Field Type Default Description
allDayLabel? string ‘All Day’ The all day editor’s label text.
titleLabel? string ‘Title’ The title editor’s label text.
startDateLabel? string ‘Start Date’ The start date editor’s label text.
endDateLabel? string ‘End Date’ The end date editor’s label text.
commitCommand? string ‘Save’ The commit button’s text.
cancelCommand? string ‘Cancel’ The cancel button’s text.

Plugin Components

Name Properties Description
AppointmentForm.Popup AppointmentForm.PopupProps A component that renders the appointment form’s popup.
AppointmentForm.Container AppointmentForm.ContainerProps A component that renders the appointment form’s container.
AppointmentForm.ScrollableArea AppointmentForm.ScrollableAreaProps A component that renders the appointment form’s scrollable area.
AppointmentForm.StaticArea AppointmentForm.StaticAreaProps A component that renders the appointment form’s static area.

Additional properties are added to a component’s root element.