Merge pull request #4 from koordinates/route-event-onload-meta-flag

src/routing/createRoute/createRoute.ts

@@ -180,6 +180,11 @@ export type SharedMeta = {
    * If true, use history.replace instead history.push
    */
   replace?: boolean;
+
+  /**
+   * true if the event was triggered by the initial match of the URL on load
+   */
+  onloadEvent?: boolean;
 };
 
 /**

src/utils.ts

@@ -58,3 +58,13 @@ export type StateMachineToInterpreter<T> = T extends StateMachine<
 >
   ? Interpreter<TContext, TSchema, TEvents, TState, any>
   : never;
+
+export function isLikelyPageLoad(): boolean {
+  // without performance API, we can't tell if this is a page load
+  if (typeof performance === "undefined") {
+    return false;
+  }
+
+  // if it's been < 5 seconds since the page was loaded, it's probably a page load
+  return performance.now() < 5000;
+}

src/xstateTree.tsx

@@ -23,12 +23,14 @@ import {
   Route,
   RoutingContext,
   RoutingEvent,
+  SharedMeta,
 } from "./routing";
 import { useActiveRouteEvents } from "./routing/providers";
 import { GetSlotNames, Slot } from "./slots";
 import { XstateTreeMachineStateSchema, GlobalEvents } from "./types";
 import { useConstant } from "./useConstant";
 import { useService } from "./useService";
+import { isLikelyPageLoad } from "./utils";
 
 export const emitter = new TinyEmitter();
 
@@ -361,7 +363,8 @@ export function buildRootComponent<
           routing.basePath,
           getPathName(),
           getQueryString(),
-          setActiveRouteEvents
+          setActiveRouteEvents,
+          { onloadEvent: isLikelyPageLoad() } as SharedMeta
         );
 
         // Hack to ensure the initial location doesn't have undefined state

xstate-tree.api.md

@@ -295,6 +295,7 @@ export type SharedMeta = {
     doNotNotifyReactRouter?: boolean;
     indexEvent?: boolean;
     replace?: boolean;
+    onloadEvent?: boolean;
 };
 
 // @public (undocumented)