Skip to content
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

Remove queryKey: false from docs. #337

Merged
merged 2 commits into from
Jul 25, 2016
Merged

Remove queryKey: false from docs. #337

merged 2 commits into from
Jul 25, 2016

Conversation

vslinko
Copy link
Contributor

@vslinko vslinko commented Jul 24, 2016

No description provided.

@taion
Copy link
Contributor

taion commented Jul 24, 2016

Thanks!

@@ -2,7 +2,7 @@

Using `window.location.hash` is a common trick that is used to mimic the HTML5 history API in older browsers. It works for most use cases and provides good compatibility across a wide range of browsers. However, in order to preserve state across browser sessions we need a place to store some state.

HTML5 gives us the `pushState` method and the `popstate` event, but in older browsers the only thing we have is the URL. So, when using hash history, you'll see an extra item in your query string that looks something like `_k=123abc`. This is a key that `history` uses to look up persistent state data in `window.sessionStorage` between page loads. If you prefer to use a different query parameter, or to opt-out of this behavior entirely, use the `queryKey` configuration option.
HTML5 gives us the `pushState` method and the `popstate` event, but in older browsers the only thing we have is the URL. So, when using hash history, you'll see an extra item in your query string that looks something like `_k=123abc`. This is a key that `history` uses to look up persistent state data in `window.sessionStorage` between page loads. If you prefer to use a different query parameter, use the `queryKey` configuration option.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you change

when using hash history

to

when using location.state with hash history

or something to that effect?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@taion
Copy link
Contributor

taion commented Jul 25, 2016

👍

@taion taion merged commit 56274b8 into remix-run:master Jul 25, 2016
@basarat
Copy link

basarat commented Aug 16, 2016

Curious why?

Refs : remix-run/react-router#1967 (comment) 🌹

@johnnyreilly
Copy link

Yup - would also love to know; this is useful information!

@lock lock bot locked as resolved and limited conversation to collaborators Jan 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants