A plugin that renders the menu that allows users to edit recurrent appointments. Should not be used with the IntegratedEditing plugin.
Use the following statement to import the plugin with embedded theme components:
import { EditRecurrenceMenu } from '@devexpress/dx-react-scheduler-material-ui';If you are going to use custom theme components, import the themeless version of this plugin instead:
import { EditRecurrenceMenu } from '@devexpress/dx-react-scheduler';| Name | Type | Default | Description |
|---|---|---|---|
| layoutComponent | ComponentType<EditRecurrenceMenu.LayoutProps> | A component that renders the menu's layout. | |
| overlayComponent | ComponentType<EditRecurrenceMenu.OverlayProps> | A component that renders the overlay window. | |
| buttonComponent | ComponentType<EditRecurrenceMenu.ButtonProps> | A component that renders the OK and Cancel buttons. | |
| messages | EditRecurrenceMenu.LocalizationMessages | An object that contains localized messages. |
Properties passed to a component that renders the edit menu's layout.
| Field | Type | Description |
|---|---|---|
| isDeleting | boolean | true if the appointment is being deleted or false if it is being edited. |
| buttonComponent | ComponentType<EditRecurrenceMenu.ButtonProps> | A component that renders the OK and Cancel buttons. |
| handleClose | () => void | A function that closes the menu. |
| commit | (value?: string) => void | A function that commits changes. |
| availableOperations | Array<string> | A list of available editing operations. |
| getMessage | (messageKey: string) => string | A function that returns a message with the specified key. |
Properties passed to a component that renders the overlay window.
| Field | Type | Description |
|---|---|---|
| target | ReactInstance | A React component instance or a DOM element that is used to position the window. |
| visible | boolean | A flag that specifies whether the overlay window is visible. |
| onHide | () => void | A function that is executed when the window is hidden. |
| children | ReactNode | A React node used to render the window's content. |
Properties passed to a component that renders the OK and Cancel buttons.
| Field | Type | Description |
|---|---|---|
| title | string | The button's text. |
| onClick | () => void | A function that is executed when the button is clicked. |
| Field | Type | Default | Description |
|---|---|---|---|
| current? | string | 'This appointment' | Text for the 'Current appointment' option. |
| currentAndFollowing? | string | 'This and following appointments' | Text for the 'Current and following appointments' option. |
| all? | string | 'All appointments' | Text for the 'All appointments' option. |
| menuEditingTitle? | string | 'Edit recurring appointment' | The menu's title that should be displayed when an appointment is being edited. |
| menuDeletingTitle? | string | 'Delete recurring appointment' | The menu's title that should be displayed when an appointment is being deleted. |
| cancelButton? | string | 'Cancel' | The Cancel button's text. |
| commitButton? | string | 'OK' | The OK button's text. |
| Name | Properties | Description |
|---|---|---|
| EditRecurrenceMenu.Layout | EditRecurrenceMenu.LayoutProps | A component that renders the edit menu's layout. |
| EditRecurrenceMenu.Overlay | EditRecurrenceMenu.OverlayProps | A component that renders the overlay window. |
| EditRecurrenceMenu.Button | EditRecurrenceMenu.ButtonProps | A component that renders the OK and Cancel buttons. |
Additional properties are added to the component's root element.