UNPKG

8.81 kBMarkdownView Raw
1## [v3.0.0]
2> May 30, 2016
3
4- `location.query` has no prototype
5- Warn about protocol-relative URLs ([#243])
6- **Bugfix:** Ignore errors when saving hash history state if
7 `window.sessionStorage` is undefined ([#295])
8- **Bugfix:** Fix replacing hash path in IE served via file protocol ([#126])
9
10[v3.0.0]: https://github.com/mjackson/history/compare/v3.0.0-2...v3.0.0
11[#243]: https://github.com/mjackson/history/issues/243
12[#295]: https://github.com/mjackson/history/issues/295
13[#126]: https://github.com/mjackson/history/issues/126
14
15## [v3.0.0-2]
16> Apr 19, 2016
17
18- Lower-cased UMD build file name
19
20[v3.0.0-2]: https://github.com/mjackson/history/compare/v3.0.0-1...v3.0.0-2
21
22## [v3.0.0-1]
23> Apr 19, 2016
24
25- Added `locationsAreEqual` to top-level exports
26- **Breakage:** Removed support for `<base href>` as `basename` ([#94])
27- Removed dependency on `deep-equal`
28
29[v3.0.0-1]: https://github.com/mjackson/history/compare/v3.0.0-0...v3.0.0-1
30[#94]: https://github.com/mjackson/history/issues/94
31
32## [3.0.0-0]
33> Mar 19, 2016
34
35- Added `history.getCurrentLocation()` method
36- **Breakage:** `history.listen` no longer calls the callback synchronously once.
37 Use `history.getCurrentLocation` instead
38- **Breakage:** `location.key` on the initial POP is `null`. Users who relied on
39 this key may immediately use `replace` to get it back
40- **Breakage:** `location.state` is `undefined` (instead of `null`) if the location
41 has no state. This helps us know when we need to access session storage and when
42 we can safely ignore it
43- **Bugfix:** Hash history now uses a custom query string key/value pair only if
44 the location has state. This obsoletes using `{ queryKey: false }` to prevent
45 the query string from being used ([#163])
46- **Bugfix:** Do not access `window.sessionStorage` unless the location has state.
47 This should minimize the # of times we access session storage and allow users to
48 opt-out of using it entirely by not using location state
49
50[3.0.0-0]: https://github.com/mjackson/history/compare/v2.0.0...v3.0.0-0
51[#163]: https://github.com/mjackson/history/issues/163
52
53## [v2.0.0]
54> Feb 4, 2016
55
56- **Bugfix:** Fix search base logic with an empty query ([#221])
57- **Bugfix:** Fail gracefully when Safari 5 security settings prevent access to window.sessionStorage ([#223])
58
59[v2.0.0]: https://github.com/mjackson/history/compare/v2.0.0-rc3...v2.0.0
60[#221]: https://github.com/mjackson/history/issues/221
61[#223]: https://github.com/mjackson/history/pull/223
62
63## [v2.0.0-rc3]
64> Feb 3, 2016
65
66- **Bugfix:** Don't convert same-path `PUSH` to `REPLACE` when `location.state` changes ([#179])
67- **Bugfix:** Re-enable browser history on Chrome iOS ([#208])
68- **Bugfix:** Properly support location descriptors in `history.createLocation` ([#200])
69
70[v2.0.0-rc3]: https://github.com/mjackson/history/compare/v2.0.0-rc2...v2.0.0-rc3
71[#179]: https://github.com/mjackson/history/pull/179
72[#208]: https://github.com/mjackson/history/pull/208
73[#200]: https://github.com/mjackson/history/pull/200
74
75## [v2.0.0-rc2]
76> Jan 9, 2016
77
78- Add back deprecation warnings
79
80[v2.0.0-rc2]: https://github.com/mjackson/history/compare/v2.0.0-rc1...v2.0.0-rc2
81
82## [v2.0.0-rc1]
83> Jan 2, 2016
84
85- **Bugfix:** Don't create empty entries in session storage ([#177])
86
87[v2.0.0-rc1]: https://github.com/mjackson/history/compare/v1.17.0...v2.0.0-rc1
88[#177]: https://github.com/mjackson/history/pull/177
89
90## [v1.17.0]
91> Dec 19, 2015
92
93- **Bugfix:** Don't throw in memory history when out of history entries ([#170])
94- **Bugfix:** Fix the deprecation warnings on `createPath` and `createHref` ([#189])
95
96[v1.17.0]: https://github.com/mjackson/history/compare/v1.16.0...v1.17.0
97[#170]: https://github.com/mjackson/history/pull/170
98[#189]: https://github.com/mjackson/history/pull/189
99
100## [v1.16.0]
101> Dec 10, 2015
102
103- **Bugfix:** Silence all warnings that were introduced since 1.13 (see [reactjs/react-router#2682])
104- Deprecate the `createLocation` method in the top-level exports
105- Deprecate the `state` arg to `history.createLocation`
106
107[v1.16.0]: https://github.com/mjackson/history/compare/v1.15.0...v1.16.0
108[reactjs/react-router#2682]: https://github.com/reactjs/react-router/issues/2682
109
110## [v1.15.0]
111> Dec 7, 2015
112
113- Accept location descriptors in `createPath` and `createHref` ([#173])
114- Deprecate the `query` arg to `createPath` and `createHref` in favor of using location descriptor objects ([#173])
115
116[v1.15.0]: https://github.com/mjackson/history/compare/v1.14.0...v1.15.0
117[#173]: https://github.com/mjackson/history/pull/173
118
119## [v1.14.0]
120> Dec 6, 2015
121
122- Accept objects in `history.push` and `history.replace` ([#141])
123- Deprecate `history.pushState` and `history.replaceState` in favor of passing objects to `history.push` and `history.replace` ([#168])
124- **Bugfix:** Disable browser history on Chrome iOS ([#146])
125- **Bugfix:** Do not convert same-path PUSH to REPLACE if the hash has changed ([#167])
126- Add ES2015 module build ([#152])
127- Use query-string module instead of qs to save on bytes ([#121])
128
129[v1.14.0]: https://github.com/mjackson/history/compare/v1.13.1...v1.14.0
130[#121]: https://github.com/mjackson/history/issues/121
131[#141]: https://github.com/mjackson/history/pull/141
132[#146]: https://github.com/mjackson/history/pull/146
133[#152]: https://github.com/mjackson/history/pull/152
134[#167]: https://github.com/mjackson/history/pull/167
135[#168]: https://github.com/mjackson/history/pull/168
136
137## [v1.13.1]
138> Nov 13, 2015
139
140- Fail gracefully when Safari security settings prevent access to window.sessionStorage
141- Pushing the currently active path will result in a replace to not create additional browser history entries ([#43])
142- Strip the protocol and domain from `<base href>` ([#139])
143
144[v1.13.1]: https://github.com/mjackson/history/compare/v1.13.0...v1.13.1
145[#43]: https://github.com/mjackson/history/pull/43
146[#139]: https://github.com/mjackson/history/pull/139
147
148## [v1.13.0]
149> Oct 28, 2015
150
151- `useBasename` transparently handles trailing slashes ([#108])
152- `useBasename` automatically uses the value of `<base href>` when no
153 `basename` option is provided ([#94])
154
155[v1.13.0]: https://github.com/mjackson/history/compare/v1.12.6...v1.13.0
156[#108]: https://github.com/mjackson/history/pull/108
157[#94]: https://github.com/mjackson/history/issues/94
158
159## [v1.12.6]
160> Oct 25, 2015
161
162- Add `forceRefresh` option to `createBrowserHistory` that forces
163 full page refreshes even when the browser supports pushState ([#95])
164
165[v1.12.6]: https://github.com/mjackson/history/compare/v1.12.5...v1.12.6
166[#95]: https://github.com/mjackson/history/issues/95
167
168## [v1.12.5]
169> Oct 11, 2015
170
171- Un-deprecate top-level createLocation method
172- Add ability to use `{ pathname, search, hash }` object anywhere
173 a path can be used
174- Fix `useQueries` handling of hashes ([#93])
175
176[v1.12.5]: https://github.com/mjackson/history/compare/v1.12.4...v1.12.5
177[#93]: https://github.com/mjackson/history/issues/93
178
179## [v1.12.4]
180> Oct 9, 2015
181
182- Fix npm postinstall hook on Windows ([#62])
183
184[v1.12.4]: https://github.com/mjackson/history/compare/v1.12.3...v1.12.4
185[#62]: https://github.com/mjackson/history/issues/62
186
187## [v1.12.3]
188> Oct 7, 2015
189
190- Fix listenBefore hooks not being called unless a listen hook was also registered ([#71])
191- Add a warning when we cannot save state in Safari private mode ([#42])
192
193[v1.12.3]: https://github.com/mjackson/history/compare/v1.12.2...v1.12.3
194[#71]: https://github.com/mjackson/history/issues/71
195[#42]: https://github.com/mjackson/history/issues/42
196
197## [v1.12.2]
198> Oct 6, 2015
199
200- Fix hash support (see [comments in #51][#51-comments])
201
202[v1.12.2]: https://github.com/mjackson/history/compare/v1.12.1...v1.12.2
203[#51-comments]: https://github.com/mjackson/history/pull/51#issuecomment-143189672
204
205## [v1.12.1]
206> Oct 5, 2015
207
208- Give `location` objects a `key` by default
209- Deprecate `history.setState`
210
211[v1.12.1]: https://github.com/mjackson/history/compare/v1.12.0...v1.12.1
212
213## [v1.12.0]
214> Oct 4, 2015
215
216- Add `history.createLocation` instance method. This allows history enhancers such as `useQueries` to modify `location` objects when creating them directly
217- Deprecate `createLocation` method on top-level exports
218
219[v1.12.0]: https://github.com/mjackson/history/compare/v1.11.1...v1.12.0
220
221## [v1.11.1]
222> Sep 26, 2015
223
224- Fix `location.basename` when location matches exactly ([#68])
225- Allow transitions to be interrupted by another
226
227[v1.11.1]: https://github.com/mjackson/history/compare/v1.11.0...v1.11.1
228[#68]: https://github.com/mjackson/history/issues/68
229
230## [v1.11.0]
231> Sep 24, 2015
232
233- Add `useBasename` history enhancer
234- Add `history.listenBefore`
235- Add `history.listenBeforeUnload` to `useBeforeUnload` history enhancer
236- Deprecate (un)registerTransitionHook
237- Deprecate (un)registerBeforeUnloadHook
238- Fix installing directly from git repo
239
240[v1.11.0]: https://github.com/mjackson/history/compare/v1.10.2...v1.11.0