Update the documentation for version 5.10.2

slax57 · slax57 · commit 1b239e3de5aa · 2025-08-25T16:05:39.000+02:00
diff --git a/AuthProviderList.md b/AuthProviderList.md
@@ -8,6 +8,7 @@ title: "Supported Auth Provider Backends"
 It's very common that your auth logic is so specific that you'll need to write your own `authProvider`. However, the community has built a few open-source Auth Providers that may fit your need:
 
 <div class="providers-list" markdown="1">
+- ![Apisix logo](./img/backend-logos/apisix.svg "Apisix logo")**[Apache Apisix OIDC](https://apisix.apache.org/)**: [@arte/ra-apisix-oidc](https://www.npmjs.com/package/@arte/ra-apisix-oidc)
 - ![Appwrite Logo](./img/backend-logos/appwrite.svg "Appwrite Logo")**[Appwrite](https://appwrite.io/)**: [marmelab/ra-appwrite](https://github.com/marmelab/ra-appwrite)
 - ![auth0 Logo](./img/backend-logos/auth0.svg "auth0 Logo")**[Auth0 by Okta](https://auth0.com/)**: [marmelab/ra-auth-auth0](https://github.com/marmelab/ra-auth-auth0/blob/main/packages/ra-auth-auth0/Readme.md)
 - ![amplify Logo](./img/backend-logos/amplify.svg "amplify Logo")**[AWS Amplify](https://docs.amplify.aws)**: [MrHertal/react-admin-amplify](https://github.com/MrHertal/react-admin-amplify)
diff --git a/DataTable.md b/DataTable.md
@@ -1871,3 +1871,23 @@ npx jscodeshift ./path/to/src/ \
     --parser=tsx \
     --transform=./node_modules/ra-core/codemods/replace-Datagrid-DataTable.ts
 ```
+
+Here is what the codemod will transform for you:
+
+- Replace `<Datagrid>` with `<DataTable>`.
+- Replace `rowStyle` with `rowSx`.
+- Remove the `optimized` prop (which isn't necessary anymore)
+- Rename the keys in `sx` prop from `"& .RaDatagrid-xxxx"` to `"& .RaDataTable-xxxx"`.
+- Replace simple `<TextField>` with `<DataTable.Col>`.
+- Replace simple `<NumberField>` with `<DataTable.NumberCol>`.
+- Wrap all other fields in `<DataTable.Col>`, keeping `source` and `label` properties in `<DataTable.Col>`.
+- Replace `Datagrid` imports by `DataTable`, and remove unused `TextField` and `NumberField` imports if they are now all replaced.
+
+However, the codemod will **not**:
+
+- Replace `<DatagridConfigurable>` with `<DataTable>` (column selection is now natively supported by `<DataTable>`).
+- Remove the `sortBy` and `sortable` props on fields (sorting is now managed by `<DataTable.Col source>`)
+- Move the `sortByOrder` prop from the field to `<DataTable.Col>`
+- Replace a `<FunctionField>` child with `<DataTable.Col render>`
+- Replace `<Datagrid>` from `@react-admin/ra-rbac` (and all its children). Refer to [Access Control section](#access-control) to use `<DataTable>` with `<CanAccess>`.
+- Move the column styles from `<Datagrid sx>` to the individual `<DataTable.Col sx>`
diff --git a/Edit.md b/Edit.md
@@ -413,6 +413,8 @@ const PostEdit = () => (
 
 {% endraw %}
 
+**Warning**: If you set `mutationOptions` meta without [redirecting](#redirect), make sure that [`queryOptions`](#queryoptions) meta is the same, or you will have data update issues.
+
 You can also use `mutationOptions` to override success or error side effects, by setting the `mutationOptions` prop. Refer to the [useMutation documentation](https://tanstack.com/query/v5/docs/react/reference/useMutation) in the react-query website for a list of the possible options.
 
 Let's see an example with the success side effect. By default, when the save action succeeds, react-admin shows a notification, and redirects to the list page. You can override this behavior and pass custom success side effects by providing a `mutationOptions` prop with an `onSuccess` key:
@@ -561,6 +563,8 @@ export const PostShow = () => (
 
 {% endraw %}
 
+**Warning**: If you set `queryOptions` meta without [redirecting](#redirect), make sure that [`mutationOptions`](#mutationoptions) meta is the same, or you will have data update issues.
+
 You can also use `queryOptions` to force a refetch on reconnect:
 
 {% raw %}
@@ -596,7 +600,9 @@ const PostEdit = () => (
 );
 ```
 
-Note that the `redirect` prop is ignored if you set [the `mutationOptions` prop](#mutationoptions). See that prop for how to set a different redirection path in that case.
+Note that the `redirect` prop is ignored if you set an `onSuccess` callback of [the `mutationOptions` prop](#mutationoptions). See that prop for how to set a different redirection path in that case.
+
+**Warning**: If you set [`queryOptions`](#queryoptions) meta without redirecting, make sure that [`mutationOptions`](#mutationoptions) meta is the same, or you will have data update issues.
 
 ## `render`
 
diff --git a/Scheduler.md b/Scheduler.md
@@ -61,20 +61,19 @@ It uses all the available horizontal and vertical space in the layout's content
 
 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:
 
-| Prop                | Required | Type      | Default     | Description                                                                              |
-| ------------------- | -------- | --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `actions`           | Optional | ReactNode |             | A component displayed on top of the scheduler, usually to display a toolbar with action buttons |
-| `converters`        | Optional | object    |             | An object containing converters from dataProvider records to Bryntum models and vice-versa |
-| `CreateDialogProps` | Optional | object    |             | Props to pass to the `<CreateDialog>` used to create new events |
-| `EditDialogProps`   | Optional | object    |             |  Props to pass to the `<EditDialog>` used to edit existing events |
-| `eventCreate`       | Optional | ReactNode |             | The form used to create new events |
-| `eventEdit`         | Optional | ReactNode |             | The form used to edit existing events |
-| `eventName`         | Optional | string |                | The name of the resource for _Events_ |
-| `mutationOptions`   | Optional | object    |             | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
-| `resourcesName`     | Optional | string    | 'resources' | The name of the resource for _Resources_  |
-| `queryOptions`      | Optional | object    |             | The query options sent when fetching _Events_ and _Resources_ |
-| `sx`                | Optional | object    |             | The sx prop passed down to the wrapping `<div>` element |
-| `title`             | Optional | object    |             | The title to display in the `<AppBar>` |
+| Prop                | Required | Type      | Default                                        | Description                                                                                                    |
+|---------------------| -------- | --------- |------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
+| `actions`           | Optional | ReactNode |                                                | A component displayed on top of the scheduler, usually to display a toolbar with action buttons                |
+| `converters`        | Optional | object    |                                                | An object containing converters from dataProvider records to Bryntum models and vice-versa                     |
+| `CreateDialogProps` | Optional | object    |                                                | Props to pass to the `<CreateDialog>` used to create new events                                                |
+| `EditDialogProps`   | Optional | object    |                                                | Props to pass to the `<EditDialog>` used to edit existing events                                               |
+| `eventCreate`       | Optional | ReactNode |                                                | The form used to create new events                                                                             |
+| `eventEdit`         | Optional | ReactNode |                                                | The form used to edit existing events                                                                          |
+| `mutationOptions`   | Optional | object    |                                                | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
+| `resources`         | Optional | object    | `{ resources: "resources", events: "events" }` | The resources names to use for _Events_ and _Resources_                                                        |
+| `queryOptions`      | Optional | object    |                                                | The query options sent when fetching _Events_ and _Resources_                                                  |
+| `sx`                | Optional | object    |                                                | The sx prop passed down to the wrapping `<div>` element                                                        |
+| `title`             | Optional | object    |                                                | The title to display in the `<AppBar>`                                                                         |
 
 ## `actions`
 
diff --git a/_data/versions.yml b/_data/versions.yml
@@ -1,4 +1,4 @@
-- latest (5.10.1)
+- latest (5.10.2)
 - "5.9"
 - "5.8"
 - "5.7"
diff --git a/doc/5.10/AuthProviderList.md b/doc/5.10/AuthProviderList.md
@@ -8,6 +8,7 @@ title: "Supported Auth Provider Backends"
 It's very common that your auth logic is so specific that you'll need to write your own `authProvider`. However, the community has built a few open-source Auth Providers that may fit your need:
 
 <div class="providers-list" markdown="1">
+- ![Apisix logo](./img/backend-logos/apisix.svg "Apisix logo")**[Apache Apisix OIDC](https://apisix.apache.org/)**: [@arte/ra-apisix-oidc](https://www.npmjs.com/package/@arte/ra-apisix-oidc)
 - ![Appwrite Logo](./img/backend-logos/appwrite.svg "Appwrite Logo")**[Appwrite](https://appwrite.io/)**: [marmelab/ra-appwrite](https://github.com/marmelab/ra-appwrite)
 - ![auth0 Logo](./img/backend-logos/auth0.svg "auth0 Logo")**[Auth0 by Okta](https://auth0.com/)**: [marmelab/ra-auth-auth0](https://github.com/marmelab/ra-auth-auth0/blob/main/packages/ra-auth-auth0/Readme.md)
 - ![amplify Logo](./img/backend-logos/amplify.svg "amplify Logo")**[AWS Amplify](https://docs.amplify.aws)**: [MrHertal/react-admin-amplify](https://github.com/MrHertal/react-admin-amplify)
diff --git a/doc/5.10/DataTable.md b/doc/5.10/DataTable.md
@@ -1871,3 +1871,23 @@ npx jscodeshift ./path/to/src/ \
     --parser=tsx \
     --transform=./node_modules/ra-core/codemods/replace-Datagrid-DataTable.ts
 ```
+
+Here is what the codemod will transform for you:
+
+- Replace `<Datagrid>` with `<DataTable>`.
+- Replace `rowStyle` with `rowSx`.
+- Remove the `optimized` prop (which isn't necessary anymore)
+- Rename the keys in `sx` prop from `"& .RaDatagrid-xxxx"` to `"& .RaDataTable-xxxx"`.
+- Replace simple `<TextField>` with `<DataTable.Col>`.
+- Replace simple `<NumberField>` with `<DataTable.NumberCol>`.
+- Wrap all other fields in `<DataTable.Col>`, keeping `source` and `label` properties in `<DataTable.Col>`.
+- Replace `Datagrid` imports by `DataTable`, and remove unused `TextField` and `NumberField` imports if they are now all replaced.
+
+However, the codemod will **not**:
+
+- Replace `<DatagridConfigurable>` with `<DataTable>` (column selection is now natively supported by `<DataTable>`).
+- Remove the `sortBy` and `sortable` props on fields (sorting is now managed by `<DataTable.Col source>`)
+- Move the `sortByOrder` prop from the field to `<DataTable.Col>`
+- Replace a `<FunctionField>` child with `<DataTable.Col render>`
+- Replace `<Datagrid>` from `@react-admin/ra-rbac` (and all its children). Refer to [Access Control section](#access-control) to use `<DataTable>` with `<CanAccess>`.
+- Move the column styles from `<Datagrid sx>` to the individual `<DataTable.Col sx>`
diff --git a/doc/5.10/Edit.md b/doc/5.10/Edit.md
@@ -413,6 +413,8 @@ const PostEdit = () => (
 
 {% endraw %}
 
+**Warning**: If you set `mutationOptions` meta without [redirecting](#redirect), make sure that [`queryOptions`](#queryoptions) meta is the same, or you will have data update issues.
+
 You can also use `mutationOptions` to override success or error side effects, by setting the `mutationOptions` prop. Refer to the [useMutation documentation](https://tanstack.com/query/v5/docs/react/reference/useMutation) in the react-query website for a list of the possible options.
 
 Let's see an example with the success side effect. By default, when the save action succeeds, react-admin shows a notification, and redirects to the list page. You can override this behavior and pass custom success side effects by providing a `mutationOptions` prop with an `onSuccess` key:
@@ -561,6 +563,8 @@ export const PostShow = () => (
 
 {% endraw %}
 
+**Warning**: If you set `queryOptions` meta without [redirecting](#redirect), make sure that [`mutationOptions`](#mutationoptions) meta is the same, or you will have data update issues.
+
 You can also use `queryOptions` to force a refetch on reconnect:
 
 {% raw %}
@@ -596,7 +600,9 @@ const PostEdit = () => (
 );
 ```
 
-Note that the `redirect` prop is ignored if you set [the `mutationOptions` prop](#mutationoptions). See that prop for how to set a different redirection path in that case.
+Note that the `redirect` prop is ignored if you set an `onSuccess` callback of [the `mutationOptions` prop](#mutationoptions). See that prop for how to set a different redirection path in that case.
+
+**Warning**: If you set [`queryOptions`](#queryoptions) meta without redirecting, make sure that [`mutationOptions`](#mutationoptions) meta is the same, or you will have data update issues.
 
 ## `render`
 
diff --git a/doc/5.10/Scheduler.md b/doc/5.10/Scheduler.md
@@ -61,20 +61,19 @@ It uses all the available horizontal and vertical space in the layout's content
 
 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:
 
-| Prop                | Required | Type      | Default     | Description                                                                              |
-| ------------------- | -------- | --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `actions`           | Optional | ReactNode |             | A component displayed on top of the scheduler, usually to display a toolbar with action buttons |
-| `converters`        | Optional | object    |             | An object containing converters from dataProvider records to Bryntum models and vice-versa |
-| `CreateDialogProps` | Optional | object    |             | Props to pass to the `<CreateDialog>` used to create new events |
-| `EditDialogProps`   | Optional | object    |             |  Props to pass to the `<EditDialog>` used to edit existing events |
-| `eventCreate`       | Optional | ReactNode |             | The form used to create new events |
-| `eventEdit`         | Optional | ReactNode |             | The form used to edit existing events |
-| `eventName`         | Optional | string |                | The name of the resource for _Events_ |
-| `mutationOptions`   | Optional | object    |             | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
-| `resourcesName`     | Optional | string    | 'resources' | The name of the resource for _Resources_  |
-| `queryOptions`      | Optional | object    |             | The query options sent when fetching _Events_ and _Resources_ |
-| `sx`                | Optional | object    |             | The sx prop passed down to the wrapping `<div>` element |
-| `title`             | Optional | object    |             | The title to display in the `<AppBar>` |
+| Prop                | Required | Type      | Default                                        | Description                                                                                                    |
+|---------------------| -------- | --------- |------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
+| `actions`           | Optional | ReactNode |                                                | A component displayed on top of the scheduler, usually to display a toolbar with action buttons                |
+| `converters`        | Optional | object    |                                                | An object containing converters from dataProvider records to Bryntum models and vice-versa                     |
+| `CreateDialogProps` | Optional | object    |                                                | Props to pass to the `<CreateDialog>` used to create new events                                                |
+| `EditDialogProps`   | Optional | object    |                                                | Props to pass to the `<EditDialog>` used to edit existing events                                               |
+| `eventCreate`       | Optional | ReactNode |                                                | The form used to create new events                                                                             |
+| `eventEdit`         | Optional | ReactNode |                                                | The form used to edit existing events                                                                          |
+| `mutationOptions`   | Optional | object    |                                                | The mutation options sent when updating _Events_ via drag/drop or resize and _Resources_ via the inline editor |
+| `resources`         | Optional | object    | `{ resources: "resources", events: "events" }` | The resources names to use for _Events_ and _Resources_                                                        |
+| `queryOptions`      | Optional | object    |                                                | The query options sent when fetching _Events_ and _Resources_                                                  |
+| `sx`                | Optional | object    |                                                | The sx prop passed down to the wrapping `<div>` element                                                        |
+| `title`             | Optional | object    |                                                | The title to display in the `<AppBar>`                                                                         |
 
 ## `actions`
 
diff --git a/doc/5.10/Theming.md b/doc/5.10/Theming.md
@@ -121,7 +121,7 @@ const App = () => (
 
 React-admin comes with 5 built-in themes:
 
-| &nbsp;&nbsp; [Default](./AppTheme.md#default) [![Default light theme](./img/defaultLightTheme1.jpg)]((AppTheme.html#default)) | &nbsp;&nbsp; [B&W](./AppTheme.md#bw) [![B&W light theme](./img/bwLightTheme1.jpg)](./AppTheme.html#bw) |
+| &nbsp;&nbsp; [Default](./AppTheme.md#default) [![Default light theme](./img/defaultLightTheme1.jpg)](AppTheme.html#default) | &nbsp;&nbsp; [B&W](./AppTheme.md#bw) [![B&W light theme](./img/bwLightTheme1.jpg)](./AppTheme.html#bw) |
 | &nbsp;&nbsp; [Nano](./AppTheme.md#nano) [![Nano light theme](./img/nanoLightTheme1.jpg)](./AppTheme.html#nano) | &nbsp;&nbsp; [Radiant](./AppTheme.md#radiant) [![Radiant light theme](./img/radiantLightTheme1.jpg)](./AppTheme.html#radiant) |
 | &nbsp;&nbsp; [House](./AppTheme.md#house) [![House light theme](./img/houseLightTheme1.jpg)](./AppTheme.html#house) |
 
diff --git a/doc/5.10/img/backend-logos/apisix.svg b/doc/5.10/img/backend-logos/apisix.svg
@@ -0,0 +1,15 @@
+<svg width="185" height="156" viewBox="0 0 185 156" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M0 155.5L94 0L185 155.5H140L94 83L42.5 155.5H0Z" fill="#F8423F"/>
+<path d="M94 82.5L42.5 155H0L76.5 57L94 82.5Z" fill="url(#paint0_linear)"/>
+<path d="M140 155.5H185L94 0L140 155.5Z" fill="url(#paint1_linear)"/>
+<defs>
+<linearGradient id="paint0_linear" x1="222.5" y1="50" x2="85" y2="223.5" gradientUnits="userSpaceOnUse">
+<stop offset="0.536111" stop-color="#FC0A04"/>
+<stop offset="1" stop-color="#CF0500" stop-opacity="0.77"/>
+</linearGradient>
+<linearGradient id="paint1_linear" x1="139.5" y1="1.50861e-06" x2="226" y2="136" gradientUnits="userSpaceOnUse">
+<stop offset="0.473466" stop-color="#E2423E"/>
+<stop offset="1" stop-color="#E2423E" stop-opacity="0.77"/>
+</linearGradient>
+</defs>
+</svg>
diff --git a/img/backend-logos/apisix.svg b/img/backend-logos/apisix.svg

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-- latest (5.10.1)`
	`1`	`+- latest (5.10.2)`
`2`	`2`	`- "5.9"`
`3`	`3`	`- "5.8"`
`4`	`4`	`- "5.7"`