Skip to content

Commit a794229

Browse files
erwanMarmelaberwanMarmelab
authored
Merge pull request #10879 from marmelab/fix-scheduler-docs
Update obsolete documentation of <Scheduler> properties
2 parents a44808c + 6957540 commit a794229

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

‎docs/Scheduler.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,19 @@ It uses all the available horizontal and vertical space in the layout's content
6161

6262
In addition to the props accepted by [Bryntum Scheduler](https://www.bryntum.com/products/scheduler/docs/guide/Scheduler/quick-start/react/), `<Scheduler>` accepts the following props:
6363

64-
| Prop | Required | Type | Default | Description |
65-
| ------------------- | -------- | --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
66-
| `actions` | Optional | ReactNode | | A component displayed on top of the scheduler, usually to display a toolbar with action buttons |
67-
| `converters` | Optional | object | | An object containing converters from dataProvider records to Bryntum models and vice-versa |
68-
| `CreateDialogProps` | Optional | object | | Props to pass to the `<CreateDialog>` used to create new events |
69-
| `EditDialogProps` | Optional | object | | Props to pass to the `<EditDialog>` used to edit existing events |
70-
| `eventCreate` | Optional | ReactNode | | The form used to create new events |
71-
| `eventEdit` | Optional | ReactNode | | The form used to edit existing events |
72-
| `eventName` | Optional | string | | The name of the resource for _Events_ |
73-
| `mutationOptions` | Optional | object | | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
74-
| `resourcesName` | Optional | string | 'resources' | The name of the resource for _Resources_ |
75-
| `queryOptions` | Optional | object | | The query options sent when fetching _Events_ and _Resources_ |
76-
| `sx` | Optional | object | | The sx prop passed down to the wrapping `<div>` element |
77-
| `title` | Optional | object | | The title to display in the `<AppBar>` |
64+
| Prop | Required | Type | Default | Description |
65+
|---------------------| -------- | --------- |------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
66+
| `actions` | Optional | ReactNode | | A component displayed on top of the scheduler, usually to display a toolbar with action buttons |
67+
| `converters` | Optional | object | | An object containing converters from dataProvider records to Bryntum models and vice-versa |
68+
| `CreateDialogProps` | Optional | object | | Props to pass to the `<CreateDialog>` used to create new events |
69+
| `EditDialogProps` | Optional | object | | Props to pass to the `<EditDialog>` used to edit existing events |
70+
| `eventCreate` | Optional | ReactNode | | The form used to create new events |
71+
| `eventEdit` | Optional | ReactNode | | The form used to edit existing events |
72+
| `mutationOptions` | Optional | object | | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
73+
| `resources` | Optional | object | `{ resources: "resources", events: "events" }` | The resources names to use for _Events_ and _Resources_ |
74+
| `queryOptions` | Optional | object | | The query options sent when fetching _Events_ and _Resources_ |
75+
| `sx` | Optional | object | | The sx prop passed down to the wrapping `<div>` element |
76+
| `title` | Optional | object | | The title to display in the `<AppBar>` |
7877

7978
## `actions`
8079

0 commit comments

Comments
 (0)