@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.54

package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md

@@ -2,7 +2,17 @@
 
 # Interface: PlayRouterProviderProps\<TActor\>
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L29)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/play-router-provider.tsx#L43)
+
+Props for the TanStack React Router `PlayRouterProvider`.
+
+`router` is the TanStack Router instance returned by `createRouter`.
+See `PlayRouterProviderBaseProps` for the stable-reference requirements on
+`actor`, `router`, and `routeMap`.
+
+## Extends
+
+- [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md)\<[`TanStackRouterInstance`](../type-aliases/TanStackRouterInstance.md), `TActor`\>
 
 ## Type Parameters
 
@@ -12,9 +22,9 @@ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:29](https:/
 
 ## Properties
 
-| Property                                  | Type                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                              | Defined in                                                                                                                                                                                          |
-| ----------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | `TActor`                                                      | The actor to sync with TanStack Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time.                                                                                                                                                                               | [play-tanstack-react-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L35) |
-| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode`                            | Renderer callback receives the same concrete actor type that was passed in.                                                                                                                                                                                                                                                                                                                                              | [play-tanstack-react-router/src/play-router-provider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L52) |
-| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md)                          | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [play-tanstack-react-router/src/play-router-provider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L50) |
-| <a id="property-router"></a> `router`     | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The TanStack Router instance returned by `createRouter`.                                                                                                                                                                                                                                                                                                                                                                 | [play-tanstack-react-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L37) |
+| Property                                  | Type                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                              | Inherited from                                                                                                                 | Defined in                                                                                                                                                                                                        |
+| ----------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`       | `TActor`                                                      | The actor to sync with the router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time.                                                                                                                                                                                    | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor)       | [play-tanstack-react-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L51) |
+| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode`                            | Renderer callback receives the same concrete actor type that was passed in.                                                                                                                                                                                                                                                                                                                                              | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [play-tanstack-react-router/src/create-play-router-provider.tsx:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L68) |
+| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md)                          | Bidirectional route map for state ID ↔ URL path lookups. **Must be a stable reference.** The bridge is rebuilt whenever `routeMap` changes identity. If constructed inline (e.g. `createRouteMapFromTree(routeTree)` in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);` | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [play-tanstack-react-router/src/create-play-router-provider.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L66) |
+| <a id="property-router"></a> `router`     | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router instance the bridge synchronizes with. Must be a stable reference.                                                                                                                                                                                                                                                                                                                                            | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router)     | [play-tanstack-react-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L53) |

package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapOptions
 
-Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L9)
+Defined in: [play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L9)
 
 Options for `createRouteMap` and `createRouteMapFromTree`.
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
 
 | Property                                     | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                | Defined in                                                                                                                                                  |
 | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L20) |
+| <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L20) |

package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteMapping
 
-Defined in: [play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L57)
+Defined in: [play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L51)
 
 A single state ID ↔ path mapping entry.
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
 
 | Property                                | Modifier   | Type     | Description                                                                   | Defined in                                                                                                                                              |
 | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L61) |
-| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L59) |
+| <a id="property-path"></a> `path`       | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L55) |
+| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`)                         | [play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L53) |

package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md

@@ -2,7 +2,7 @@
 
 # Interface: RouteNavigateEvent
 
-Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/types.ts#L21)
+Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L21)
 
 Event sent to actor when browser navigates.
 
@@ -22,5 +22,5 @@ actor.send({ type: "route.navigate", path: "/dashboard" });
 
 | Property                          | Modifier   | Type               | Description                                                  | Defined in                                                                                                                                                          |
 | --------------------------------- | ---------- | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path` | `readonly` | `string`           | Target route path (may include parameters, e.g., /posts/123) | [play-tanstack-react-router/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/types.ts#L25) |
-| <a id="property-type"></a> `type` | `readonly` | `"route.navigate"` | Event type discriminant (extends XState event pattern)       | [play-tanstack-react-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/types.ts#L23) |
+| <a id="property-path"></a> `path` | `readonly` | `string`           | Target route path (may include parameters, e.g., /posts/123) | [play-tanstack-react-router/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L25) |
+| <a id="property-type"></a> `type` | `readonly` | `"route.navigate"` | Event type discriminant (extends XState event pattern)       | [play-tanstack-react-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/types.ts#L23) |

package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md

@@ -2,11 +2,11 @@
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L341)
+Defined in: [play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L341)
 
 RouterBridge interface for runtime infrastructure adapters
 
-Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
+Defines the lifecycle connection between Infrastructure (e.g., a framework router) and
 the Actor. Infrastructure "bridges" to the Actor by observing its signals and
 managing its own lifecycle accordingly.
 
@@ -16,13 +16,13 @@ a unidirectional observation pattern. Infrastructure connects to observe Actor s
 
 ## Example
 
-TanStack Router bridge implementation
+Framework router bridge implementation
 
 ```typescript
 import type { RouterBridge } from "@xmachines/play-router";
 import { Signal } from "@xmachines/play-signals";
 
-class TanStackRouterBridge implements RouterBridge {
+class MyRouterBridge implements RouterBridge {
 	private watcher: Signal.Watcher | null = null;
 
 	async connect(): Promise<void> {
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L357)
+Defined in: [play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L357)
 
 Connect the router bridge to the Actor
 
@@ -83,7 +83,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L373)
+Defined in: [play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L373)
 
 Disconnect the router bridge from the Actor
 

package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md

@@ -0,0 +1,30 @@
+[API](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouterBridgeConstructor
+
+# Type Alias: PlayRouterBridgeConstructor\<TRouter\>
+
+```ts
+type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
+```
+
+Defined in: [play-tanstack-react-router/src/create-play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/create-play-router-provider.tsx#L31)
+
+Constructor shape a bridge class must satisfy to be used with
+`createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TRouter`      |
+
+## Parameters
+
+| Parameter  | Type                                      |
+| ---------- | ----------------------------------------- |
+| `router`   | `TRouter`                                 |
+| `actor`    | [`PlayActor`](../interfaces/PlayActor.md) |
+| `routeMap` | [`RouteMap`](../classes/RouteMap.md)      |
+
+## Returns
+
+[`RouterBridge`](../interfaces/RouterBridge.md)

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md

@@ -6,4 +6,4 @@
 type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L27)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/play-router-provider.tsx#L34)

package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md

@@ -6,7 +6,11 @@
 type TanStackRouterLike = object;
 ```
 
-Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L41)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
+
+Structural (type-only) interface for the TanStack Router surface used by
+`TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
+`@tanstack/solid-router` instances satisfy it.
 
 ## Properties
 
@@ -16,7 +20,7 @@ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:41](https:
 history: object;
 ```
 
-Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L44)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
 
 #### location
 
@@ -64,7 +68,11 @@ subscribe(handler): () => void;
 optional load(): void | Promise<void>;
 ```
 
-Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
+
+Re-runs TanStack route matching and loaders for the current location.
+Optional: the bridge calls it (fire-and-forget) after every navigation so
+matching/loaders stay in sync even without a mounted `<RouterProvider>`.
 
 #### Returns
 
@@ -78,7 +86,7 @@ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https:
 navigate(args): void;
 ```
 
-Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L42)
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
 
 #### Parameters
 

package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md

@@ -1,12 +1,12 @@
 [API](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouterProvider
 
-# Function: PlayRouterProvider()
+# Variable: PlayRouterProvider
 
 ```ts
-function PlayRouterProvider<TActor>(__namedParameters): Element;
+const PlayRouterProvider: <TActor>(__namedParameters) => Element;
 ```
 
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-tanstack-react-router/src/play-router-provider.tsx#L63)
+Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-react-router/src/play-router-provider.tsx#L57)
 
 Connects a `PlayerActor` to TanStack React Router, keeping actor state and
 browser URL in sync bidirectionally.
@@ -14,6 +14,8 @@ browser URL in sync bidirectionally.
 The bridge is created once on mount and torn down on unmount. It is also
 rebuilt if `actor`, `router`, or `routeMap` change identity — so all three
 props must be **stable references** (created outside JSX or memoized).
+Under React `<StrictMode>` the effect runs twice on mount
+(connect → disconnect → connect), which the bridge supports.
 
 ## Type Parameters
 
@@ -23,9 +25,9 @@ props must be **stable references** (created outside JSX or memoized).
 
 ## Parameters
 
-| Parameter           | Type                                                                              |
-| ------------------- | --------------------------------------------------------------------------------- |
-| `__namedParameters` | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md)\<`TActor`\> |
+| Parameter           | Type                                                                                                                                                     |
+| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `__namedParameters` | [`PlayRouterProviderBaseProps`](../interfaces/PlayRouterProviderBaseProps.md)\<[`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md), `TActor`\> |
 
 ## Returns
 

package/api/@xmachines/play-tanstack-router/README.md

@@ -0,0 +1,58 @@
+[API](../../README.md) / @xmachines/play-tanstack-router
+
+# @xmachines/play-tanstack-router
+
+Shared, framework-agnostic TanStack Router bridge base for XMachines Play.
+
+TanStack Router exposes the identical `navigate` / `load` / `history` surface in
+both its React and Solid flavours, so the entire bridge implementation lives here
+as `TanStackRouterBridgeBase` (extending `RouterBridgeBase` from
+[`@xmachines/play-router`](../play-router/README.md)). The framework adapter
+packages only subclass it to bind their concrete router type.
+
+This package has **no TanStack runtime dependency** — `TanStackRouterLike` is a
+structural, type-only interface covering the small router surface the bridge uses.
+
+## Who consumes it
+
+- [`@xmachines/play-tanstack-react-router`](../play-tanstack-react-router/README.md) — TanStack Router adapter (React)
+- [`@xmachines/play-tanstack-solid-router`](../play-tanstack-solid-router/README.md) — TanStack Router adapter (SolidJS)
+
+## Usage
+
+```typescript
+import { TanStackRouterBridgeBase } from "@xmachines/play-tanstack-router";
+
+export class MyTanStackBridge extends TanStackRouterBridgeBase {}
+
+const bridge = new MyTanStackBridge(router, actor, routeMap);
+bridge.connect();
+// Cleanup on unmount
+return () => bridge.disconnect();
+```
+
+## Exports
+
+- `TanStackRouterBridgeBase` — abstract bridge base class
+- `TanStackRouterLike` — structural (type-only) TanStack router surface
+- `TanStackRouteMapLike` — narrow route-map surface the bridge requires
+
+## License
+
+MIT
+
+@xmachines/play-tanstack-router
+
+Shared, framework-agnostic TanStack Router bridge base for XMachines Play.
+Consumed by `@xmachines/play-tanstack-react-router` and
+`@xmachines/play-tanstack-solid-router`, which subclass
+`TanStackRouterBridgeBase` to bind their concrete router type.
+
+## Classes
+
+- [TanStackRouterBridgeBase](classes/TanStackRouterBridgeBase.md)
+
+## Type Aliases
+
+- [TanStackRouteMapLike](type-aliases/TanStackRouteMapLike.md)
+- [TanStackRouterLike](type-aliases/TanStackRouterLike.md)