ReferenceOneField accept sort & filter props #8306
Conversation
docs/ReferenceOneField.md
Outdated
| @@ -5,7 +5,7 @@ title: "The ReferenceOneField Component" | |||
|
|
|||
| # `<ReferenceOneField>` | |||
|
|
|||
| This field fetches a one-to-one relationship, e.g. the details of a book, when using a foreign key on the distant resource. | |||
| This field fetches a one-to-one relationship or the first record of a one-to-many relationship, e.g. the details of a book, when using a foreign key on the distant resource. | |||
There was a problem hiding this comment.
I would not mention this use-case so early in the doc, since it's after all a quite specialized use-case, and we want this first paragraph to introduce the most common use-case of the component only (let's keep things simple 😉 ).
Instead I'd mention this ability later, for instance as a Tip.
There was a problem hiding this comment.
Also, you need to update the ## Properties section too, to document these new props
docs/ReferenceOneField.md
Outdated
| @@ -18,7 +18,7 @@ This field fetches a one-to-one relationship, e.g. the details of a book, when u | |||
| └──────────────┘ | |||
| ``` | |||
|
|
|||
| `<ReferenceOneField>` behaves like `<ReferenceManyField>`: it uses the current `record` (a book in this example) to build a filter for the book details with the foreign key (`book_id`). Then, it uses `dataProvider.getManyReference('book_details', { target: 'book_id', id: book.id })` to fetch the related details, and takes the first one. | |||
| `<ReferenceOneField>` behaves like `<ReferenceManyField>`: it uses the current `record` (a book in this example) to build a filter for the book details with the foreign key (`book_id`) and optional additional filters. Then, it uses `dataProvider.getManyReference('book_details', { target: 'book_id', id: book.id })` to fetch the related details, and takes the first one. | |||
There was a problem hiding this comment.
Same, let's not mention the 'optional additional filters' so early, and keep them for later in the doc.
| export interface SortPayload { | ||
| field: string; | ||
| order: SortOrder; | ||
| } |
There was a problem hiding this comment.
I would recommend avoiding duplication of the SortPayload interface, and using the one from ra-core instead. It does not force the SortOrder to be 'ASC' | 'DESC', but actually we shouldn't force it since it's dependent on the dataProvider.
|
Oh and one last thing, since it's a new feature, your PR should target the |
nicgirault
force-pushed
the
master
branch
2 times, most recently
from
bf58bc6
to
4c26045
Compare
|
@slax57 thanks for your review. Are you satisfied with the latest changes? |
Fix #8304