Skip to content

[Doc] Update RA Core EE documentation #11037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 19, 2025
+4 −4
Merged

[Doc] Update RA Core EE documentation #11037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs_headless/src/content/docs/ReferenceManyInputBase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const ProductEdit = () => (
| ----------------- | -------- | ------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `target` | Required | `string` | - | Target field carrying the relationship on the referenced resource, e.g. 'user_id' |
| `reference` | Required | `string` | - | The name of the resource for the referenced records, e.g. 'books' |
| `children` | Optional | `ReactNode` | - | One or several elements that render a list of records based on a `ListContext` |
| `children` | Optional | `Element` | - | One or several elements that render a list of records based on a `ListContext` |
| `defaultValue` | Optional | `array` | - | Default value of the input. |
| `filter` | Optional | `Object` | - | Filters to use when fetching the related records, passed to `getManyReference()` |
| `mutationOptions` | Optional | `UseMutationOptions` | - | Options for the mutations (`create`, `update` and `delete`) |
Expand Down
6 changes: 3 additions & 3 deletions docs_headless/src/content/docs/ReferenceOneInputBase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ const BookEdit = () => (
| ----------------- | -------- | -------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `target` | Required | `string` | - | Target field carrying the relationship on the referenced resource, e.g. 'book_id' |
| `reference` | Required | `string` | - | The name of the resource for the referenced records, e.g. 'book_details' |
| `children` | Optional | `ReactNode` | - | One or several input elements that accept a `source` prop |
| `children` | Optional | `Element` | - | One or several input elements that accept a `source` prop |
| `defaultValue` | Optional | `Object` | - | Default value for the related record (in case it does not yet exist) |
| `error` | Optional | `ReactNode` | - | The element to display when an error occurs while loading a reference |
| `error` | Optional | `Element` | - | The element to display when an error occurs while loading a reference |
| `filter` | Optional | `Object` | - | Filters to use when fetching the related record, passed to `getManyReference() |
| `loading` | Optional | `ReactNode` | - | The element to display while loading a reference |
| `loading` | Optional | `Element` | - | The element to display while loading a reference |
| `mutationOptions` | Optional | `UseMutationOptions` | - | Options for the mutations (`create` and `update`) |
| `render` | Optional | `Function` | - | A function that returns the children to display. Takes precedence over `children` |
| `sort` | Optional | `{ field, order }` | `{ field: 'id', order: 'ASC' }` | Sort order to use when fetching the related record, passed to `getManyReference() |
Expand Down
Loading