Skip to content
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

Jump to bottom

Added queryOptions to ReferenceManyField (#9669) #9679

Closed
wants to merge 1 commit into from
Closed

Added queryOptions to ReferenceManyField (#9669) #9679

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/ra-core/src/controller/field/useReferenceManyFieldController.ts
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@ export interface UseReferenceManyFieldControllerParams<
sort?: SortPayload;
source?: string;
target: string;
queryOptions?: { meta?: any };
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad type. This should be UseGetManyReferenceHookOptions<RecordType>

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean that I should change it like this?

export interface UseGetManyReferenceHookOptions<RecordType> {
  meta?: any
}
...
  queryOptions?: UseGetManyReferenceHookOptions<RecordType>

This is the type of queryOptions in ReferenceOneField.tsx, which I used as a reference

queryOptions?: UseQueryOptions<{
        data: ReferenceRecordType[];
        total: number;
    }> & { meta?: any };

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Nela62

Indeed there is no UseGetManyReferenceHookOptions. But I believe what @fzaninotto means is that you should use the same type as what useGetManyReference() expects, plus meta, i.e.:

queryOptions?: UseQueryOptions<{ data: RecordType[]; total: number }, Error> & { meta?: any };

}

const defaultFilter = {};
Expand Down Expand Up @@ -72,8 +73,10 @@ export const useReferenceManyFieldController = <
page: initialPage,
perPage: initialPerPage,
sort: initialSort = { field: 'id', order: 'DESC' },
queryOptions = {},
} = props;
const notify = useNotify();
const { meta } = queryOptions;
const resource = useResourceContext(props);

// pagination logic
Expand Down Expand Up @@ -178,6 +181,7 @@ export const useReferenceManyFieldController = <
pagination: { page, perPage },
sort,
filter: filterValues,
meta,
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should also pass the remaining quetry options to the query, see e.g.

react-admin/packages/ra-core/src/controller/edit/useEditController.ts

Line 99 in 5e2ed7d

...otherQueryOptions,

{
enabled: get(record, source) != null,
Expand Down
5 changes: 4 additions & 1 deletion packages/ra-ui-materialui/src/field/ReferenceManyField.tsx
View file
Open in desktop
Expand Up @@ -77,8 +77,9 @@ export const ReferenceManyField = <
sort = defaultSort,
source = 'id',
target,
queryOptions,
} = props;
const record = useRecordContext(props);
const record = useRecordContext<RecordType>(props);

const controllerProps = useReferenceManyFieldController<
RecordType,
Expand All @@ -94,6 +95,7 @@ export const ReferenceManyField = <
sort,
source,
target,
queryOptions,
});

return (
Expand All @@ -118,6 +120,7 @@ export interface ReferenceManyFieldProps<
reference: string;
sort?: SortPayload;
target: string;
queryOptions?: { meta?: any };
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

}

ReferenceManyField.propTypes = {
Expand Down