UNPKG

@hickory/browser

Version:

Hickory's browser history

pshrmn/hickory

91 lines (51 loc) • 2.63 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
## 2.1.0 - Added `confirm` method for adding and removing navigation confirmation. ## 2.0.0 The following is a consolidation of the pre-v2 changes. ### Exports - The function to create a browser history is now a named export: `browser`. - The `browser` function takes a `ResponseHandler` as its first argument and an optional options object as its second argument. - Remove navigation blocking from `browser` history. - Add `createBase` export, which is a function that creates a base object to be passed as the `base` option (see options below). ### `history.url` - Rename `history.toHref` to `history.url`. The `url` function expects the provided `pathname` to be absolute. - `url` function can take a location object or a string. ### `history.navigate` - The first argument to `history.navigate` is an object with shape `{ url: string, state?: any }`. - The history object will automatically cancel the pending navigation when another navigation happens. ### `history.current` - Add `history.current` function that emits a navigation for the current location (with a no-op functions for finishing and cancelling the navigation). ### `history.cancel` - Add `history.cancel` function for cancelling the active navigation. ### `history.destroy` - Destroyed `history` instance no longer emits navigation. ### locations - `location.key` is now a two number tuple (`[1, 0]` instead of `1.0`). - Remove `location.rawPathname`. - Remove `location.url` ### `options` - Rename `baseSegment` option to `base`. - Remove `raw` option. ### Other - Remove event coordinator (handle events manually) ## 1.0.2 - Revert dual-mode (not ready yet!). ## 1.0.1 - Build UMD, not IIFE - Support dual-mode package (CJS/ESM) builds with `.js` and `.mjs` files. ## 1.0.0 - Wrap `pushState()` and `replaceState()` calls in a `try..catch` to protect against iOS Safari limits. ## 1.0.0-beta.7 - `history.go()` and `history.go(0)` now reload the page. - Unify `navigate()`, `push()`, and `replace()` under `navigate()`. The optional second argument controls which type of navigation: `ANCHOR` (default), `PUSH`, or `REPLACE`. ## 1.0.0-beta.6 - Re-export `LocationDetails`. - Don't publish source maps. ## 1.0.0-beta.5 - Switch to using a response handler (assigned using `respondWith`) instead of the `subscriber` model. ## 1.0.0-beta.4 - Rename `update` to `navigate`. ## 1.0.0-beta.3 - Switch to TypeScript. ## 1.0.0-beta.2 - Add `raw` option to `Hash` options. This defaults to a function that will generate the encoded version of a pathname (by setting an anchor element's `href` attribute and reading its `pathname`).