Update docs website, bump to 1.3.0

craftedbygc · Jun 1, 2023 · cde27e5 · cde27e5
1 parent ec0d74e
commit cde27e5
Show file tree

Hide file tree

Showing 13 changed files with 42 additions and 22 deletions.
diff --git a/dist/taxi.esm.js b/dist/taxi.esm.js
diff --git a/dist/taxi.esm.js.map b/dist/taxi.esm.js.map
diff --git a/dist/taxi.js b/dist/taxi.js
diff --git a/dist/taxi.js.map b/dist/taxi.js.map
diff --git a/dist/taxi.modern.js b/dist/taxi.modern.js
diff --git a/dist/taxi.modern.js.map b/dist/taxi.modern.js.map
diff --git a/dist/taxi.umd.js b/dist/taxi.umd.js
diff --git a/dist/taxi.umd.js.map b/dist/taxi.umd.js.map
diff --git a/docs/assets/js/index.js b/docs/assets/js/index.js
@@ -86,7 +86,9 @@ E.on('DOMContentLoaded', window, function () {
 	fetch('https://api.github.com/repos/craftedbygc/taxi')
 		.then((response) => response.json())
 		.then((data) => {
-			starcount.innerHTML = convertStars(data.stargazers_count)
+			if (!data.message) {
+				starcount.innerHTML = convertStars(data.stargazers_count)
+			}
 		})
 		.catch((error) => {
 			console.error('Error:', error);

diff --git a/docs/how-to-use.md b/docs/how-to-use.md
@@ -127,6 +127,11 @@ Default behaviour is to cache the contents of a URL after fetching it to make re
 If you want default behaviour, but wish to force certain pages to always be fetched (and never loaded from cache), you can add the `data-taxi-nocache` attribute to the `data-taxi-view` element on that page. 
 
 
+### enablePrefetch `boolean`
+Default behaviour is to preload links on your website whenever the `mouseenter` or `focus` event is triggered.
+
+If you want to disable this or want to implement your own preloading strategy, set this to `false`.
+
 ### reloadJsFilter `bool|function(element: HTMLElement)`
 Please see [Reloading JS]({{ global.url }}/reloading-js/) for more information.
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@unseenco/taxi",
 	"description": "A modern page transition library which supports routing, preloading, and additional script reloading.",
-	"version": "1.2.2",
+	"version": "1.3.0",
 	"license": "GPL-3.0-or-later",
 	"source": "src/taxi.js",
 	"main": "src/taxi.js",
@@ -25,7 +25,7 @@
 		}
 	],
 	"dependencies": {
-		"@unseenco/e": "^2.2.1"
+		"@unseenco/e": "^2.3.0"
 	},
 	"devDependencies": {
 		"@11ty/eleventy": "^1.0.1",

diff --git a/src/Core.d.ts b/src/Core.d.ts
@@ -1,7 +1,7 @@
 /**
  * @typedef CacheEntry
  * @type {object}
- * @property {typeof Renderer} renderer
+ * @property {typeof Renderer|Renderer} renderer
  * @property {Document|Node} page
  * @property {array} scripts
  * @property {boolean} skipCache
@@ -15,6 +15,7 @@ export default class Core {
      * 		removeOldContent?: boolean,
      * 		allowInterruption?: boolean,
      * 		bypassCache?: boolean,
+     * 		enablePrefetch?: boolean,
      * 		renderers?: Object.<string, typeof Renderer>,
      * 		transitions?: Object.<string, typeof Transition>,
      * 		reloadJsFilter?: boolean|function(HTMLElement): boolean
@@ -25,6 +26,7 @@ export default class Core {
         removeOldContent?: boolean;
         allowInterruption?: boolean;
         bypassCache?: boolean;
+        enablePrefetch?: boolean;
         renderers?: {
             [x: string]: typeof Renderer;
         };
@@ -42,6 +44,11 @@ export default class Core {
      * @type {Map<string, CacheEntry>}
      */
     cache: Map<string, CacheEntry>;
+    /**
+     * @private
+     * @type {Map<string, Promise>}
+     */
+    private activePromises;
     renderers: {
         [x: string]: typeof Renderer;
     };
@@ -55,6 +62,7 @@ export default class Core {
     removeOldContent: boolean;
     allowInterruption: boolean;
     bypassCache: boolean;
+    enablePrefetch: boolean;
     isPopping: boolean;
     currentLocation: {
         raw: string;
@@ -168,6 +176,11 @@ export default class Core {
      * @return {void|boolean}
      */
     private onPopstate;
+    /**
+     * @private
+     * @param {MouseEvent} e
+     */
+    private onPrefetch;
     /**
      * @private
      * @param {string} url
@@ -189,7 +202,7 @@ export default class Core {
     private createCacheEntry;
 }
 export type CacheEntry = {
-    renderer: typeof Renderer;
+    renderer: typeof Renderer | Renderer;
     page: Document | Node;
     scripts: any[];
     skipCache: boolean;