Skip to content

docs(react-query): highlight per component select pattern for query options #8522

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
TkDodo merged 3 commits into from
Jan 11, 2025
Merged

docs(react-query): highlight per component select pattern for query options #8522

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bae2921
docs(react-query): per component select pattern
DogPawHat Jan 10, 2025
f241230
Update docs/framework/react/guides/query-options.md
TkDodo Jan 11, 2025
1f69528
Merge branch 'main' into highlight-per-component-select-pattern
TkDodo Jan 11, 2025
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
15 changes: 15 additions & 0 deletions docs/framework/react/guides/query-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,18 @@ queryClient.setQueryData(groupOptions(42).queryKey, newGroups)
[//]: # 'Example1'

For Infinite Queries, a separate [`infiniteQueryOptions`](../reference/infiniteQueryOptions.md) helper is available.

You can still override some options at the component level. A very common and useful pattern is to create per-component [`select`](../guides/render-optimizations.md#select) functions:

Comment thread
TkDodo marked this conversation as resolved.
[//]: # 'Example2'

```ts
// Type inference still works, so query.data will be the return type of select instead of queryFn

const query = useQuery({
...groupOptions(1),
select: (data) => data.groupName,
})
```

[//]: # 'Example2'