Skip to content

Persisting store doc href hash fixes and tweaks #1398

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
merged 3 commits into from
Nov 3, 2022
Merged

Persisting store doc href hash fixes and tweaks #1398

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a2ed38
chore(docs): Fix casing in Persist middleware docs
wmcb91 Oct 29, 2022
70ecfa8
docs: Remove unhelpful 'see below' and make other more helpful
wmcb91 Oct 29, 2022
c2474a6
docs: Remove link incompatible between GH & Docs site.
wmcb91 Nov 2, 2022
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
9 changes: 3 additions & 6 deletions docs/integrations/persisting-store-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav: 17
The persist middleware enables you to store your Zustand state in a storage (e.g. `localStorage`, `AsyncStorage`, `IndexedDB`, etc...) thus persisting it's data.

Note that this middleware does support both synchronous storages (e.g. `localStorage`) and asynchronous storages (e.g. `AsyncStorage`), but using an asynchronous storage does come with a cost.
See [Hydration and asynchronous storages](#Hydration-and-asynchronous-storages) for more details.
See [Hydration and asynchronous storages](#hydration-and-asynchronous-storages) for more details.

Quick example:

Expand All @@ -28,8 +28,6 @@ export const useFishStore = create(
)
```

See [Options](#Options) for more details.

## Options

### `name`
Expand Down Expand Up @@ -206,8 +204,7 @@ export const useBoundStore = create(

If you want to introduce a breaking change in your storage (e.g. renaming a field), you can specify a new version number.
By default, if the version in the storage does not match the version in the code, the stored value won't be used.

See the `migrate` option below for more details about handling breaking changes.
You can use the `migrate` option to handle breaking changes in order to persist previously stored data.

### `migrate`

Expand Down Expand Up @@ -412,7 +409,7 @@ Why does it matter?
Asynchronous hydration can cause some unexpected behaviors.
For instance, if you use Zustand in a React app, the store will _not_ be hydrated at the initial render. In cases where you app depends on the persisted value at page load, you might want to wait until the store has been hydrated before showing anything (e.g. your app might think the user is not logged in because it's the default, while in reality the store has not been hydrated yet).

If your app does depends on the persisted state at page load, see [How can I check if my store has been hydrated?](#how-can-I-check-if-my-store-has-been-hydrated) in the Q/A.
If your app does depends on the persisted state at page load, see [How can I check if my store has been hydrated?](#how-can-i-check-if-my-store-has-been-hydrated?) in the Q/A.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The inclusion of the "?" is an interesting one. For a quick bit of background, we want the docs to work on the docs site, but also, we want them to continue to work within Github.

At the moment, the fix here makes sense in the context of the docs (which is currently broken for that link), but it wouldn't work in the context of Github, because it looks like Github strips the "?".

I wonder if we can introduce a fix on https://github.com/pmndrs/website/ so it is consistent with github? Technically a question mark is allowed in the fragment identifier but it would be good to be consistent across both GH/docs.

Sorry, I know that is a bit of a rabbit hole for a case fix! Is it something you want to raise/fix with the website repo? If not, I can look at doing it

Copy link
Collaborator

Choose a reason for hiding this comment

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

A quick update @wmcb91 , I've raised a query over on the website repo: https://github.com/pmndrs/website/issues/259
I want to get Cody's 2c on the approach. Sorry about the hold up


## Q/A

Expand Down