|
| selectedDate | Date. Initial selected date. _Default_: new Date() |
| navigation | boolean. Show/Hide top bar date navigation. _Default_: true |
| navigationPickerProps | CalendarPickerProps for top bar date navigation. Ref: [CalendarPicker API](https://mui.com/x/api/date-pickers/calendar-picker/#main-content) |
| disableViewNavigator | boolean. Show/Hide top bar date View navigator. _Default_: false |
| events | Array of ProcessedEvent. _Default_: []
type ProcessedEvent = { event_id: number or string; title: string; start: Date; end: Date; disabled?: boolean; color?: string or "palette.path"; textColor?: string or "palette.path"; editable?: boolean; deletable?: boolean; draggable?: boolean; allDay?: boolean; }
|
| eventRenderer | Function(event:ProcessedEvent): JSX.Element. A function that overrides the event item render function, see demo _Custom Event Renderer_ below |
| editable | boolean. If `true`, the scheduler cell click will not open the editor, and the event item will not show the edit button, this is applied to all events, and can be overridden in each event property, see `ProcessedEvent` type. |
| deletable | boolean. Whether the event item will show the delete button, this is applied to all events, and can be overridden in each event property, see `ProcessedEvent` type. |
| draggable | boolean. Whether activate drag&drop for the events, this is applied to all events, and can be overridden in each event property, see `ProcessedEvent` type. |
| getRemoteEvents | Function(RemoteQuery). Return promise of array of events. Can be used as a callback to fetch events by parent component or fetch.
|
| loading | boolean. Loading state of the calendar table | |
| loadingComponent | Custom component to override the default `CircularProgress` |
| onConfirm | Function(event, action). Return promise with the new added/edited event use with remote data. _action_: "add", "edit" |
| onDelete | Function(id) Return promise with the deleted event id to use with remote data. |
| customEditor | Function(scheduler). Override editor modal. Provided prop _scheduler_ object with helper props:
|
| customViewer | Function(event: ProcessedEvent, close: () => void). Used to render fully customized content of the event popper. If used, `viewerExtraComponent` & `viewerTitleComponent` will be ignored |
| viewerExtraComponent | Function(fields, event) OR Component. Additional component in event viewer popper |
| viewerTitleComponent | Function(event). Helper function to render custom title in event popper |
| resources | Array. Resources array to split event views with resources _Example_
|
| onEventDrop | Function(droppedOn: Date, updatedEvent: ProcessedEvent, originalEvent: ProcessedEvent). Return a promise, used to update remote data of the dropped event. Return an event to update state internally, or void if event state is managed within component |
| onEventClick | Function(event: ProcessedEvent): void. Triggered when an event item is clicked |
| onSelectedDateChange | Function(date: Date): void. Triggered when the `selectedDate` prop changes by navigation date picker or `today` button |
| onViewChange | Function(view: View): void. Triggered when navigation view changes |
| stickyNavigation | If true, the navigation controller bar will be sticky |
### SchedulerRef
Used to help manage and control the internal state of the `Scheduler` component from outside of `Scheduler` props, Example:
```js
import { Scheduler } from "@aldabil/react-scheduler";
import type { SchedulerRef } from "@aldabil/react-scheduler/types"
const SomeComponent = () => {
const calendarRef = useRef(null);
return
};
```
The `calendarRef` holds the entire internal state of the Scheduler component. Perhaps the most useful method inside the `calendarRef` is `handleState`, example:
```
calendarRef.current.scheduler.handleState(value, key);
```
consider looking inside `SchedulerRef` type to see all fields & methods available.
### Demos
- [Basic](https://codesandbox.io/s/react-scheduler-demo-standard-v96bd)
- [Remote Data](https://codesandbox.io/s/remote-data-j13ei)
- [Custom Fields](https://codesandbox.io/s/custom-fields-b2kbv)
- [Editor/Viewer Override](https://codesandbox.io/s/customeditor-tt2pf)
- [Resources/View Mode](https://codesandbox.io/s/resources-7wlcy)
- [Custom Cell Action](https://codesandbox.io/s/custom-cell-action-n02dv)
- [Custom Event Renderer](https://codesandbox.io/s/custom-event-renderer-rkf4xw)
### Todos
- [ ] Tests
- [x] Drag&Drop - partially
- [ ] Resizable
- [ ] Recurring events
- [x] Localization
- [x] Hour format 12 | 24
---
_Source: https://npm.io/package/@cardial/react-scheduler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._