aberdeen 1.6.0 → 1.7.0

package/skill/dispatcher.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.6.0**](README.md)
+[**Aberdeen v1.7.0**](README.md)
 
 ***
 
@@ -10,13 +10,16 @@
 
 ### Dispatcher
 
-Defined in: [dispatcher.ts:58](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/dispatcher.ts#L58)
+Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L61)
 
 Simple route matcher and dispatcher.
 
 Example usage:
 
 ```ts
+import * as route from 'aberdeen/route';
+import { Dispatcher, MATCH_REST } from 'aberdeen/dispatcher';
+
 const dispatcher = new Dispatcher();
 
 dispatcher.addRoute("user", Number, "stream", String, (id, stream) => {
@@ -26,7 +29,7 @@ dispatcher.addRoute("user", Number, "stream", String, (id, stream) => {
 dispatcher.dispatch(["user", "42", "stream", "music"]);
 // Logs: User 42, stream music
 
-dispatcher.addRoute("search", matchRest, (terms: string[]) => {
+dispatcher.addRoute("search", MATCH_REST, (terms: string[]) => {
     console.log("Search terms:", terms);
 });
 
@@ -50,7 +53,7 @@ dispatcher.dispatch(["search", "classical", "piano"]);
 
 > **addRoute**\<`T`, `H`\>(...`args`): `void`
 
-Defined in: [dispatcher.ts:70](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/dispatcher.ts#L70)
+Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L73)
 
 Add a route with matchers and a handler function.
 
@@ -76,8 +79,8 @@ Handler function type, inferred from the matchers.
 
 An array of matchers followed by a handler function. Each matcher can be:
 - A string: matches exactly that string.
-- A function: takes a string segment and returns a value (of any type) if it matches, or [matchFailed](#matchfailed) if it doesn't match. The return value (if not `matchFailed` and not `NaN`) is passed as a parameter to the handler function. The built-in functions `Number` and `String` can be used to match numeric and string segments respectively.
-- The special [matchRest](#matchrest) symbol: matches the rest of the segments as an array of strings. Only one `matchRest` is allowed, and it must be the last matcher.
+- A function: takes a string segment and returns a value (of any type) if it matches, or [MATCH\_FAILED](#match_failed) if it doesn't match. The return value (if not `MATCH_FAILED` and not `NaN`) is passed as a parameter to the handler function. The standard JavaScript functions `Number` and `String` can be used to match numeric and string segments respectively.
+- The special [MATCH\_REST](#match_rest) symbol: matches the rest of the segments as an array of strings. Only one `MATCH_REST` is allowed.
 
 ###### Returns
 
@@ -87,7 +90,7 @@ An array of matchers followed by a handler function. Each matcher can be:
 
 > **dispatch**(`segments`): `boolean`
 
-Defined in: [dispatcher.ts:91](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/dispatcher.ts#L91)
+Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L94)
 
 Dispatches the given segments to the first route handler that matches.
 
@@ -107,20 +110,20 @@ True if a matching route was found and handled, false otherwise.
 
 ## Variables
 
-### matchFailed
+### MATCH\_FAILED
 
-> `const` **matchFailed**: unique `symbol`
+> `const` **MATCH\_FAILED**: unique `symbol`
 
-Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/dispatcher.ts#L4)
+Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L4)
 
 Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot match a segment.
 
 ***
 
-### matchRest
+### MATCH\_REST
 
-> `const` **matchRest**: unique `symbol`
+> `const` **MATCH\_REST**: unique `symbol`
 
-Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/dispatcher.ts#L9)
+Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L9)
 
 Special [Dispatcher.addRoute](#addroute) matcher that matches the rest of the segments as an array of strings.

package/skill/prediction.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.6.0**](README.md)
+[**Aberdeen v1.7.0**](README.md)
 
 ***
 
@@ -12,7 +12,7 @@
 
 > **applyCanon**(`canonFunc?`, `dropPredictions?`): `void`
 
-Defined in: [prediction.ts:115](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/prediction.ts#L115)
+Defined in: [prediction.ts:115](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/prediction.ts#L115)
 
 Temporarily revert all outstanding predictions, optionally run the provided function
 (which will generally make authoritative changes to the data based on a server response),
@@ -50,7 +50,7 @@ An optional list of predictions (as returned by `applyPrediction`)
 
 > **applyPrediction**(`predictFunc`): `Patch`
 
-Defined in: [prediction.ts:93](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/prediction.ts#L93)
+Defined in: [prediction.ts:93](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/prediction.ts#L93)
 
 Run the provided function, while treating all changes to Observables as predictions,
 meaning they will be reverted when changes come back from the server (or some other

package/skill/route.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.6.0**](README.md)
+[**Aberdeen v1.7.0**](README.md)
 
 ***
 
@@ -10,7 +10,7 @@
 
 ### Route
 
-Defined in: [route.ts:8](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L8)
+Defined in: [route.ts:8](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L8)
 
 The class for the global `route` object.
 
@@ -20,7 +20,7 @@ The class for the global `route` object.
 
 > **depth**: `number`
 
-Defined in: [route.ts:20](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L20)
+Defined in: [route.ts:20](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L20)
 
 The navigation depth of the current session. Starts at 1. Writing to this property has no effect.
 
@@ -28,7 +28,7 @@ The navigation depth of the current session. Starts at 1. Writing to this proper
 
 > **hash**: `string`
 
-Defined in: [route.ts:14](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L14)
+Defined in: [route.ts:14](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L14)
 
 The hash fragment including the leading `#`, or an empty string. For instance `"#my_section"` or `""`.
 
@@ -36,7 +36,7 @@ The hash fragment including the leading `#`, or an empty string. For instance `"
 
 > **nav**: `NavType`
 
-Defined in: [route.ts:28](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L28)
+Defined in: [route.ts:28](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L28)
 
 The navigation action that got us to this page. Writing to this property has no effect.
 - `"load"`: An initial page load.
@@ -49,7 +49,7 @@ Mostly useful for page transition animations. Writing to this property has no ef
 
 > **p**: `string`[]
 
-Defined in: [route.ts:12](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L12)
+Defined in: [route.ts:12](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L12)
 
 An convenience array containing path segments, mapping to `path`. For instance `[]` (for `"/"`) or `['users', '123', 'feed']` (for `"/users/123/feed"`).
 
@@ -57,7 +57,7 @@ An convenience array containing path segments, mapping to `path`. For instance `
 
 > **path**: `string`
 
-Defined in: [route.ts:10](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L10)
+Defined in: [route.ts:10](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L10)
 
 The current path of the URL as a string. For instance `"/"` or `"/users/123/feed"`. Paths are normalized to always start with a `/` and never end with a `/` (unless it's the root path).
 
@@ -65,7 +65,7 @@ The current path of the URL as a string. For instance `"/"` or `"/users/123/feed
 
 > **search**: `Record`\<`string`, `string`\>
 
-Defined in: [route.ts:16](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L16)
+Defined in: [route.ts:16](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L16)
 
 The query string interpreted as search parameters. So `"a=x&b=y"` becomes `{a: "x", b: "y"}`.
 
@@ -73,7 +73,7 @@ The query string interpreted as search parameters. So `"a=x&b=y"` becomes `{a: "
 
 > **state**: `Record`\<`string`, `any`\>
 
-Defined in: [route.ts:18](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L18)
+Defined in: [route.ts:18](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L18)
 
 An object to be used for any additional data you want to associate with the current page. Data should be JSON-compatible.
 
@@ -83,7 +83,7 @@ An object to be used for any additional data you want to associate with the curr
 
 > `const` **current**: [`Route`](#route)
 
-Defined in: [route.ts:261](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L261)
+Defined in: [route.ts:332](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L332)
 
 The global [Route](#route) object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
 
@@ -93,7 +93,7 @@ The global [Route](#route) object reflecting the current URL and browser history
 
 > **back**(`target`): `void`
 
-Defined in: [route.ts:185](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L185)
+Defined in: [route.ts:190](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L190)
 
 Try to go back in history to the first entry that matches the given target. If none is found, the given state will replace the current page. This is useful for "cancel" or "close" actions that should return to the previous page if possible, but create a new page if not (for instance when arriving at the current page through a direct link).
 
@@ -117,7 +117,7 @@ The target route to go back to. May be a subset of [Route](#route), or a string
 
 > **go**(`target`, `nav`): `void`
 
-Defined in: [route.ts:151](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L151)
+Defined in: [route.ts:156](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L156)
 
 Navigate to a new URL by pushing a new history entry.
 
@@ -154,11 +154,39 @@ route.go({p: ["users", 123], search: {tab: "feed"}, hash: "top"});
 
 ***
 
+### interceptLinks()
+
+> **interceptLinks**(): `void`
+
+Defined in: [route.ts:277](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L277)
+
+Intercept clicks and Enter key presses on links (`<a>` tags) and use Aberdeen routing
+instead of browser navigation for local paths (paths without a protocol or host).
+
+This allows you to use regular HTML anchor tags for navigation without needing to
+manually attach click handlers to each link.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```js
+// In your root component:
+route.interceptLinks();
+
+// Now you can use regular anchor tags:
+$('a text=About href=/corporate/about');
+```
+
+***
+
 ### persistScroll()
 
 > **persistScroll**(`name`): `void`
 
-Defined in: [route.ts:237](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L237)
+Defined in: [route.ts:242](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L242)
 
 Restore and store the vertical and horizontal scroll position for
 the parent element to the page state.
@@ -184,7 +212,7 @@ The scroll position will be persisted in `route.aux.scroll.<name>`.
 
 > **push**(`target`): `void`
 
-Defined in: [route.ts:172](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L172)
+Defined in: [route.ts:177](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L177)
 
 Modify the current route by merging `target` into it (using [merge](aberdeen.md#merge)), pushing a new history entry.
 
@@ -208,7 +236,7 @@ Same as for [go](#go), but merged into the current route instead deleting all st
 
 > **setLog**(`value`): `void`
 
-Defined in: [route.ts:37](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L37)
+Defined in: [route.ts:37](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L37)
 
 Configure logging on route changes.
 
@@ -230,7 +258,7 @@ Configure logging on route changes.
 
 > **up**(`stripCount`): `void`
 
-Defined in: [route.ts:210](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/route.ts#L210)
+Defined in: [route.ts:215](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L215)
 
 Navigate up in the path hierarchy, by going back to the first history entry
 that has a shorter path than the current one. If there's none, we just shorten

package/skill/transitions.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.6.0**](README.md)
+[**Aberdeen v1.7.0**](README.md)
 
 ***
 
@@ -12,7 +12,7 @@
 
 > **grow**(`el`): `Promise`\<`void`\>
 
-Defined in: [transitions.ts:33](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/transitions.ts#L33)
+Defined in: [transitions.ts:33](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/transitions.ts#L33)
 
 Do a grow transition for the given element. This is meant to be used as a
 handler for the `create` property.
@@ -38,7 +38,7 @@ for other specific cases as well.
 
 > **shrink**(`el`): `Promise`\<`void`\>
 
-Defined in: [transitions.ts:56](https://github.com/vanviegen/aberdeen/blob/6b79c7fce769810bdcbd326b8ee6ef1c8e1fc011/src/transitions.ts#L56)
+Defined in: [transitions.ts:56](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/transitions.ts#L56)
 
 Do a shrink transition for the given element, and remove it from the DOM
 afterwards. This is meant to be used as a handler for the `destroy` property.