-
-
Notifications
You must be signed in to change notification settings - Fork 654
fix: re-export useSelector and document useStore migration #2206
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.
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
Open
hemraj-007
wants to merge
2
commits into
TanStack:main
Choose a base branch
from
hemraj-007:fix/use-selector-export-2203
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| '@tanstack/react-form': patch | ||
| '@tanstack/preact-form': patch | ||
| '@tanstack/vue-form': patch | ||
| '@tanstack/solid-form': patch | ||
| '@tanstack/svelte-form': patch | ||
| --- | ||
|
|
||
| Re-export `useSelector` from TanStack Store adapters and document migration from deprecated `useStore` (fixes #2203). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| id: useSelector | ||
| title: useSelector | ||
| --- | ||
|
|
||
| # Variable: useSelector() | ||
|
|
||
| ```ts | ||
| const useSelector: <TSource, TSelected>(source, selector?, options?) => TSelected; | ||
| ``` | ||
|
|
||
| Re-exported from `@tanstack/preact-store`. Use this hook to subscribe to slices of `form.store` inside component logic. | ||
|
|
||
| ## Example | ||
|
|
||
| ```tsx | ||
| import { useForm, useSelector } from '@tanstack/preact-form' | ||
|
|
||
| const form = useForm({ /* ... */ }) | ||
| const firstName = useSelector(form.store, (state) => state.values.firstName) | ||
| ``` | ||
|
|
||
| ## Migration from useStore | ||
|
|
||
| `useStore` is deprecated; import `useSelector` from `@tanstack/preact-form` instead. The API is the same aside from optional `options.compare` instead of a bare `compare` third argument. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| id: useSelector | ||
| title: useSelector | ||
| --- | ||
|
|
||
| # Variable: useSelector() | ||
|
|
||
| ```ts | ||
| const useSelector: <TSource, TSelected>(source, selector?, options?) => TSelected; | ||
| ``` | ||
|
|
||
| Re-exported from `@tanstack/react-store`. Use this hook to subscribe to slices of `form.store` (or any TanStack Store source) inside component logic. | ||
|
|
||
| ## Parameters | ||
|
|
||
| ### source | ||
|
|
||
| A store or atom with `get()` and `subscribe()`. | ||
|
|
||
| ### selector? | ||
|
|
||
| `(snapshot) => TSelected` — strongly recommended; omitting it subscribes to the entire store and may cause extra re-renders. | ||
|
|
||
| ### options? | ||
|
|
||
| - **compare?** — `(a, b) => boolean` custom equality check (defaults to `===`). | ||
|
|
||
| ## Returns | ||
|
|
||
| `TSelected` | ||
|
|
||
| ## Example | ||
|
|
||
| ```tsx | ||
| import { useForm, useSelector } from '@tanstack/react-form' | ||
|
|
||
| const form = useForm({ /* ... */ }) | ||
| const firstName = useSelector(form.store, (state) => state.values.firstName) | ||
| ``` | ||
|
|
||
| ## Migration from useStore | ||
|
|
||
| `useStore` is a deprecated alias of `useSelector` with the same signature (the third argument is `compare` on `useStore`, or `options.compare` on `useSelector`): | ||
|
|
||
| ```tsx | ||
| // Before | ||
| import { useStore } from '@tanstack/react-form' | ||
| const firstName = useStore(form.store, (state) => state.values.firstName) | ||
|
|
||
| // After | ||
| import { useSelector } from '@tanstack/react-form' | ||
| const firstName = useSelector(form.store, (state) => state.values.firstName) | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.