Migrate docs from wiki: auto generating selectors #1057
Merged
Conversation
This file contains 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 pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 1c41c4e:
|
dai-shi
requested changes
Jul 5, 2022
Accepted suggestion to remove hint about auto-zustand-selectors-hook Co-authored-by: Daishi Kato <[email protected]>
Carnageous
force-pushed
the
docs/auto-generating-selectors
branch
from
7c57b5f to
4e03a4b
Compare
dai-shi
approved these changes
Jul 11, 2022
dai-shi
reviewed
Jul 11, 2022
Added third-party library Co-authored-by: Daishi Kato <[email protected]>
Those semicolons at the head are correct (with |
devanshj
reviewed
Jul 11, 2022
Comment on lines
+11
to
+36
| ## create the following function: `createSelectors` | ||
|
|
||
| ```typescript | ||
| import { State, StoreApi, UseBoundStore } from 'zustand' | ||
|
|
||
| interface Selectors<StoreType> { | ||
| use: { | ||
| [key in keyof StoreType]: () => StoreType[key] | ||
| } | ||
| } | ||
|
|
||
| export default function createSelectors<StoreType extends State>( | ||
| store: UseBoundStore<StoreType, StoreApi<StoreType>> | ||
| ) { | ||
| // Casting to any to allow adding a new property | ||
| ;(store as any).use = {} | ||
|
|
||
| Object.keys(store.getState()).forEach((key) => { | ||
| const selector = (state: StoreType) => state[key as keyof StoreType] | ||
| ;(store as any).use[key] = () => store(selector) | ||
| }) | ||
|
|
||
| return store as UseBoundStore<StoreType, StoreApi<StoreType>> & | ||
| Selectors<StoreType> | ||
| } | ||
| ``` |
There was a problem hiding this comment.
This code should look like this instead.
| increment: () => void | ||
| } | ||
|
|
||
| const useStoreBase = create<BearState>((set) => ({ |
There was a problem hiding this comment.
Suggested change
| const useStoreBase = create<BearState>((set) => ({ | |
| const useStoreBase = create<BearState>()((set) => ({ |
|
|
||
| ## Live Demo | ||
|
|
||
| for a working example of this, see the [Code Sandbox](https://codesandbox.io/s/zustand-auto-generate-selectors-9i0ob3?file=/src/store.ts:396-408) |
There was a problem hiding this comment.
Probably will have to update the sandbox based on the review.
|
@Carnageous Hi, can you take @devanshj comments into account? |
|
Yep, will do! I wrote the docs for the 3.x version, will adjust it in another PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Like you said in #1008 you want to migrate the docs from Github's wiki to the docs folder as markdown files and I'd like to help! This one is for Auto generating selectors.
I will work on all the pages in my fork and open PRs if that's fine?
A few things:
Looking forward to your suggestions