* Persist documentation for Map & Set add storage and retrieval of version
--HG--
branch : discussion-2689-persist-doc-map-and-set-missing-version
* Persist documentation for Map & set improve getItem to include version only when present by way of spread operator on existingValue
--HG--
branch : discussion-2689-persist-doc-map-and-set-missing-version
* docs: update documentation of persist
Add superjson serialization/deserialization example to Zustand persist documentation
* docs: fix spelling documentation of persist
* docs: Apply feedback by moving content under custom storage engine and specifying that the code is an example
* docs: Update variable name to example name and separate storage as const
The initialization type of `useState` is incorrect. hydrated needs to be of boolean type, whereas the original `useBoundStore.persist.hasHydrated` is a function. This will lead to errors, such as during the static build of frameworks like Next.js.
* Add section for usage of persist middleware with NextJS
I have spent the last 1h30m trying to find the solution for `Hydration failed because the initial UI does not match what was rendered on the server` and after digging a lot I found the solution.
So i thought: Maybe this could be on official documentation!
So I made it. It's just copy and paste but at least it will be easier for future folks trying to solve the same problem
* ran yarn prettier
* fix typos
* Update docs/integrations/persisting-store-data.md
Co-authored-by: Blazej Sewera <code@sewera.dev>
* splitting long lines into smaller ones
following the suggestion of PR
* commit suggestion of changes in PR
Co-authored-by: Blazej Sewera <code@sewera.dev>
* commit suggestion of changes in PR
Co-authored-by: Blazej Sewera <code@sewera.dev>
* commit suggestion of changes in PR
Co-authored-by: Blazej Sewera <code@sewera.dev>
* commit suggestion of changes in PR
Co-authored-by: Blazej Sewera <code@sewera.dev>
* applying changes requested in PR
---------
Co-authored-by: Blazej Sewera <code@sewera.dev>
* update documentation of persist to include how to handle Map and Set with the new persist API
* run prettier
* Update docs/integrations/persisting-store-data.md
Co-authored-by: Chris K <55621012+chrisk-7777@users.noreply.github.com>
* Update docs/integrations/persisting-store-data.md
Co-authored-by: Chris K <55621012+chrisk-7777@users.noreply.github.com>
* Update docs/integrations/persisting-store-data.md
Co-authored-by: Blazej Sewera <code@sewera.dev>
* edit suggestions
* fix comment
Co-authored-by: Chris K <55621012+chrisk-7777@users.noreply.github.com>
Co-authored-by: Blazej Sewera <code@sewera.dev>
This replaces `getStorage` with `storage`.
This PR raises two questions:
- Should we write documentation on how to migrate from the `getStorage` API to the `storage` API?
- Should we version the middleware separately from the zustand core?
* docs(#1220): revise persisting-store-data page
- add cross-links
- add line breaks for easier Markdown reading
- unify Persist middleware spelling
- change fishes to bears, because the plural of fish is fish,
and it would be less readable
- make sentences more concise
* docs(#1220): make the sentences more concise
* docs(#1220): unify formatting of methods
* chore(docs): Fix casing in Persist middleware docs
* docs: Remove unhelpful 'see below' and make other more helpful
* docs: Remove link incompatible between GH & Docs site.
* docs: context guide proposal
* fix(docs): typo & omit comment
* fix(docs): remove horizontal rules
* fix(docs): add wiki link to DI
* fix(docs): format with prettier
* fix(docs): cases that model => where... is needed
* fix(docs): use sentence case
* fix(docs): omit quote block
* fix(docs): into "a" custom hook
* fix(docs): format with prettier
* fix(docs): sort broken nav indexes
* Update docs/guides/initialize-state-with-props.md
Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
* fix(docs): reintroduce React.createContext example
* scripts: escape quotes
* styles: run prettier
* fix(docs): omit 'React' from imports
* styles: run prettier
* styles: run prettier
Co-authored-by: Daishi Kato <dai-shi@users.noreply.github.com>
