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.

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

Jump to bottom

Add in doc another helpful usage of createMemoryHistory that was very… #374

Merged
merged 2 commits into from Dec 9, 2016
Merged

Add in doc another helpful usage of createMemoryHistory that was very… #374

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43bf91e
Add in doc another helpful usage of createMemoryHistory that was very…
slorber Oct 7, 2016
3baae54
Update README.md
slorber Oct 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -37,7 +37,7 @@ You can find the library on `window.History`.
`history` provides 3 different methods for creating a `history` object, depending on your environment.

- `createBrowserHistory` is for use in modern web browsers that support the [HTML5 history API](http://diveintohtml5.info/history.html) (see [cross-browser compatibility](http://caniuse.com/#feat=history))
- `createMemoryHistory` is used as a reference implementation and may also be used in non-DOM environments, like [React Native](https://facebook.github.io/react-native/)
- `createMemoryHistory` is used as a reference implementation and may also be used in non-DOM environments, like [React Native](https://facebook.github.io/react-native/), unit-tests or server-side rendering. It can also be useful for [Cordova](https://cordova.apache.org/) applications, if you need the url to stay on Cordova's `index.html` in this specific environment, while your mobile website is already using `createBrowserHistory`
- `createHashHistory` is for use in legacy web browsers

Depending on the method you want to use to keep track of history, you'll `import` (or `require`) one of these methods directly from the package root (i.e. `history/createBrowserHistory`). The remainder of this document uses the term `createHistory` to refer to any of these implementations.
Expand Down Expand Up @@ -122,7 +122,8 @@ The `location` object implements a subset of [the `window.location` interface](h

Locations may also have the following properties:

- `location.state` - Some extra state for this location that does not reside in the URL (supported in `createBrowserHistory` and `createMemoryHistory`)
- `location.state` - Some extra state for this location that does not reside in the URL (supported in `createBrowserHistory` and `
`)
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this change wasn't intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch

- `location.key` - A unique string representing this location (supported in `createBrowserHistory` and `createMemoryHistory`)

The `action` is one of `PUSH`, `REPLACE`, or `POP` depending on how the user got to the current URL.
Expand Down