@fruit-ui/router 1.1.1 → 1.1.2

package/README.md

@@ -10,6 +10,7 @@ This is a component producer which takes in three props.
 - `routes` is an object mapping from paths (strings) to `Route`s. `Route`s are objects with a `route` method (which generates the template/component for that route, and is allowed to be asynchronous.) You can also have a 'wildcard' (*) route whose `route` method can take in the name of the current route as a prop. Each `Route` can also have an attribute `title` which will set the window's title for that path.
 - `scrollOptions` is an optional prop. It is an object describing how scrolling should be handled when the Router component rerenders. It has two attributes: `hashed` and `unhashed`. These respectively describe how scrolling should be handled given hashed (`?page=about#contact`) and unhashed (`?page=about`) paths. In each of these, you may select any options from the [scrollIntoView](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView) method, as well as an option `to: {x: number, y: number}`, which can take coordinates (in which case `scrollTo` will be used rather than `scrollIntoView`). Either can also be `false` in which case no scrolling will occur. The default value is `{hashed: {}, unhashed: {to: {x: 0, y: 0}}}`.
 - `asyncLoader` is an optional prop describing what should be displayed while an asynchronous route is loading. This is only used on the first route visited in a session; in subsequent routes, the router displays the old route until the new async route has fully loaded. The default value is `{}` (an empty `div`).
+- `initFunction` is an optional prop. It is a function that runs inside the router's `state()` function and can be used for initializing paradigms like context.
 
 Here is an example router:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fruit-ui/router",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A basic router component for FRUIT",
   "main": "src/router.js",
   "homepage": "https://asantagata.github.io/fruit-ui/?page=router-index",

package/src/router.js

@@ -56,13 +56,15 @@ function handleScrolling(element, scrollOptions) {
  * @param {Object.<string, {route: () => object, title?: string}>} routes - the collection of routes.
  * @param {object | false} [scrollOptions] - scrolling options.
  * @param {object} [asyncLoader] - loader to use while processing initial async resources
+ * @param {() => void} [initFunction] - function to run on initialization.
  * @returns {object} a component.
  */
-function Router(routes, scrollOptions = {hashed: {}, unhashed: {to: {x: 0, y: 0}}}, asyncLoader = {}) {
+function Router(routes, scrollOptions = {hashed: {}, unhashed: {to: {x: 0, y: 0}}}, asyncLoader = {}, initFunction = () => {}) {
     return {
         state() {
             const page = getPage();
             const route = getRoute(routes, page);
+            initFunction.call(this);
             return {
                 element: (() => {
                     if (Object.getPrototypeOf(route.route).constructor.name === "AsyncFunction") {