@xmachines/docs 1.0.0-beta.10 → 1.0.0-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/classes/AbstractActor.md +33 -33
- package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
- package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
- package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
- package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
- package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
- package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
- package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +22 -22
- package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +29 -29
- package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-router/functions/crawlMachine.md +4 -4
- package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +4 -4
- package/api/@xmachines/play-router/functions/extractRoute.md +6 -6
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +5 -5
- package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
- package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
- package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
- package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +6 -6
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/interfaces/StateVisit.md +6 -6
- package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +27 -27
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +27 -27
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +22 -22
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/variables/extractMachineRoutes.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +23 -23
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +4 -4
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +43 -43
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +5 -5
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +8 -8
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +10 -10
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +7 -7
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
- package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
- package/api/@xmachines/shared/functions/xmAliases.md +1 -1
- package/examples/README.md +3 -4
- package/examples/basic-state-machine.md +1 -1
- package/examples/form-validation.md +2 -2
- package/examples/traffic-light.md +1 -1
- package/guides/README.md +1 -1
- package/guides/getting-started.md +4 -12
- package/guides/installation.md +4 -5
- package/package.json +2 -2
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: TanStackReactRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L78)
|
|
6
6
|
|
|
7
7
|
TanStack React Router adapter implementing RouterBridge protocol via RouterBridgeBase
|
|
8
8
|
|
|
@@ -47,17 +47,17 @@ new TanStackReactRouterBridge(
|
|
|
47
47
|
routeMap): TanStackReactRouterBridge;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
50
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L88)
|
|
51
51
|
|
|
52
52
|
Create TanStack React Router bridge
|
|
53
53
|
|
|
54
54
|
#### Parameters
|
|
55
55
|
|
|
56
|
-
| Parameter | Type
|
|
57
|
-
| ---------- |
|
|
58
|
-
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)
|
|
59
|
-
| `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)
|
|
60
|
-
| `routeMap` | [`RouteMap`](RouteMap.md)
|
|
56
|
+
| Parameter | Type | Description |
|
|
57
|
+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
58
|
+
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack React Router instance |
|
|
59
|
+
| `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance |
|
|
60
|
+
| `routeMap` | [`RouteMap`](RouteMap.md) | Bidirectional mapping between state IDs and paths |
|
|
61
61
|
|
|
62
62
|
#### Returns
|
|
63
63
|
|
|
@@ -69,17 +69,17 @@ Create TanStack React Router bridge
|
|
|
69
69
|
|
|
70
70
|
## Properties
|
|
71
71
|
|
|
72
|
-
| Property | Modifier | Type
|
|
73
|
-
| --------------------------------------------------------------------- | ----------- |
|
|
74
|
-
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)
|
|
75
|
-
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean`
|
|
76
|
-
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean`
|
|
77
|
-
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`
|
|
78
|
-
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string`
|
|
79
|
-
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object`
|
|
80
|
-
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined`
|
|
81
|
-
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined`
|
|
82
|
-
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null`
|
|
72
|
+
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
73
|
+
| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
|
74
|
+
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | Actor with currentRoute signal and send method | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | play-router/dist/router-bridge-base.d.ts:55 |
|
|
75
|
+
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | play-router/dist/router-bridge-base.d.ts:61 |
|
|
76
|
+
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | play-router/dist/router-bridge-base.d.ts:60 |
|
|
77
|
+
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:63 |
|
|
78
|
+
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | play-router/dist/router-bridge-base.d.ts:62 |
|
|
79
|
+
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | Bidirectional route map for stateId ↔ path resolution | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | play-router/dist/router-bridge-base.d.ts:56 |
|
|
80
|
+
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:58 |
|
|
81
|
+
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:57 |
|
|
82
|
+
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | play-router/dist/router-bridge-base.d.ts:64 |
|
|
83
83
|
|
|
84
84
|
## Methods
|
|
85
85
|
|
|
@@ -196,7 +196,7 @@ Extracted query parameters or empty object
|
|
|
196
196
|
protected getInitialRouterPath(): string | null;
|
|
197
197
|
```
|
|
198
198
|
|
|
199
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
199
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L110)
|
|
200
200
|
|
|
201
201
|
Read the router's current pathname for initial sync.
|
|
202
202
|
|
|
@@ -219,7 +219,7 @@ the URL differs from the actor's initial state.
|
|
|
219
219
|
protected navigateRouter(path): void;
|
|
220
220
|
```
|
|
221
221
|
|
|
222
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
222
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L100)
|
|
223
223
|
|
|
224
224
|
Navigate the framework router to the given path.
|
|
225
225
|
|
|
@@ -307,7 +307,7 @@ Prevents circular updates via isProcessingNavigation flag.
|
|
|
307
307
|
protected unwatchRouterChanges(): void;
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
310
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L131)
|
|
311
311
|
|
|
312
312
|
Stop watching for router location changes.
|
|
313
313
|
|
|
@@ -329,7 +329,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
|
|
|
329
329
|
protected watchRouterChanges(): void;
|
|
330
330
|
```
|
|
331
331
|
|
|
332
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
332
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L123)
|
|
333
333
|
|
|
334
334
|
Subscribe to ALL navigation events via router.history.
|
|
335
335
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function PlayRouterProvider(__namedParameters): Element;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L38)
|
|
10
10
|
|
|
11
11
|
## Parameters
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createRouteMapFromTree(routeTree): RouteMap;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/route-map.ts#L73)
|
|
10
10
|
|
|
11
11
|
Create RouteMap from RouteTree
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function extractParams(pathname, pattern): Record<string, string>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/extract-params.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/extract-params.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/extract-params.ts#L29)
|
|
10
10
|
|
|
11
11
|
Extract route parameters from URL path based on route pattern using URLPattern API
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function extractQueryParams(search): Record<string, string>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/extract-params.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/extract-params.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/extract-params.ts#L68)
|
|
10
10
|
|
|
11
11
|
Extract query parameters from search string
|
|
12
12
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: PlayRouterProviderProps
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
9
|
-
| Property | Type
|
|
10
|
-
| ----------------------------------------- |
|
|
11
|
-
| <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)
|
|
12
|
-
| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode`
|
|
13
|
-
| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md)
|
|
14
|
-
| <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)
|
|
9
|
+
| Property | Type | Defined in |
|
|
10
|
+
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) & [`Viewable`](../../play-actor/interfaces/Viewable.md) | [play-tanstack-react-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L29) |
|
|
12
|
+
| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | [play-tanstack-react-router/src/play-router-provider.tsx:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L32) |
|
|
13
|
+
| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [play-tanstack-react-router/src/play-router-provider.tsx:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L31) |
|
|
14
|
+
| <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | [play-tanstack-react-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L30) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteMapping
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-react-router/src/route-map.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-react-router/src/route-map.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/route-map.ts#L22)
|
|
6
6
|
|
|
7
7
|
Mapping between state machine state ID and router path.
|
|
8
8
|
|
|
@@ -13,5 +13,5 @@ Fields are `readonly` — entries are immutable once passed to `RouteMap`.
|
|
|
13
13
|
|
|
14
14
|
| Property | Modifier | Type | Description | Defined in |
|
|
15
15
|
| --------------------------------------- | ---------- | -------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
16
|
-
| <a id="property-path"></a> `path` | `readonly` | `string` | Router path with optional parameters (e.g., `"/settings/:section?"`) | [play-tanstack-react-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
17
|
-
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State ID from state machine (e.g., `"home"`, `"settings.profile"`) | [play-tanstack-react-router/src/route-map.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
16
|
+
| <a id="property-path"></a> `path` | `readonly` | `string` | Router path with optional parameters (e.g., `"/settings/:section?"`) | [play-tanstack-react-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/route-map.ts#L26) |
|
|
17
|
+
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State ID from state machine (e.g., `"home"`, `"settings.profile"`) | [play-tanstack-react-router/src/route-map.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/route-map.ts#L24) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteNavigateEvent
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/types.ts#L21)
|
|
6
6
|
|
|
7
7
|
Event sent to actor when browser navigates.
|
|
8
8
|
|
|
@@ -22,5 +22,5 @@ actor.send({ type: "route.navigate", path: "/dashboard" });
|
|
|
22
22
|
|
|
23
23
|
| Property | Modifier | Type | Description | Defined in |
|
|
24
24
|
| --------------------------------- | ---------- | ------------------ | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
-
| <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/
|
|
26
|
-
| <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/
|
|
25
|
+
| <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/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/types.ts#L25) |
|
|
26
|
+
| <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/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/types.ts#L23) |
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type TanStackRouterInstance = ConstructorParameters<typeof TanStackReactRouterBridge>[0];
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/play-router-provider.tsx#L26)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type TanStackRouterLike = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L42)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https:
|
|
|
16
16
|
history: object;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
19
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L45)
|
|
20
20
|
|
|
21
21
|
#### subscribe()
|
|
22
22
|
|
|
@@ -42,7 +42,7 @@ subscribe(handler): () => void;
|
|
|
42
42
|
optional state?: object;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
45
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L44)
|
|
46
46
|
|
|
47
47
|
#### location?
|
|
48
48
|
|
|
@@ -64,7 +64,7 @@ optional pathname?: string;
|
|
|
64
64
|
navigate(args): void;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
67
|
+
Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
|
|
68
68
|
|
|
69
69
|
#### Parameters
|
|
70
70
|
|
|
@@ -16,9 +16,9 @@ and builds hierarchical tree.
|
|
|
16
16
|
|
|
17
17
|
## Parameters
|
|
18
18
|
|
|
19
|
-
| Parameter | Type
|
|
20
|
-
| --------- |
|
|
21
|
-
| `machine` | `AnyStateMachine` | XState v5 state machine |
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --------- | ------------------------------------------------------------------------- | ----------------------- |
|
|
21
|
+
| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState v5 state machine |
|
|
22
22
|
|
|
23
23
|
## Returns
|
|
24
24
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: RouteMap
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/route-map.ts#L26)
|
|
6
6
|
|
|
7
7
|
Shared bidirectional route map base class.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: SolidRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L45)
|
|
6
6
|
|
|
7
7
|
TanStack Solid Router integration bridge extending RouterBridgeBase
|
|
8
8
|
|
|
@@ -25,17 +25,17 @@ new SolidRouterBridge(
|
|
|
25
25
|
routeMap): SolidRouterBridge;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
28
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L55)
|
|
29
29
|
|
|
30
30
|
Create a TanStack Solid Router bridge
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
34
|
-
| Parameter | Type
|
|
35
|
-
| ---------- |
|
|
36
|
-
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)
|
|
37
|
-
| `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)
|
|
38
|
-
| `routeMap` | [`RouteMap`](RouteMap.md)
|
|
34
|
+
| Parameter | Type | Description |
|
|
35
|
+
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
|
36
|
+
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack Router instance (from createRouter) |
|
|
37
|
+
| `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | XMachines actor instance |
|
|
38
|
+
| `routeMap` | [`RouteMap`](RouteMap.md) | Bidirectional state ID ↔ path mapping |
|
|
39
39
|
|
|
40
40
|
#### Returns
|
|
41
41
|
|
|
@@ -47,17 +47,17 @@ Create a TanStack Solid Router bridge
|
|
|
47
47
|
|
|
48
48
|
## Properties
|
|
49
49
|
|
|
50
|
-
| Property | Modifier | Type
|
|
51
|
-
| --------------------------------------------------------------------- | ----------- |
|
|
52
|
-
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)
|
|
53
|
-
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean`
|
|
54
|
-
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean`
|
|
55
|
-
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`
|
|
56
|
-
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string`
|
|
57
|
-
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object`
|
|
58
|
-
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined`
|
|
59
|
-
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined`
|
|
60
|
-
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null`
|
|
50
|
+
| Property | Modifier | Type | Description | Inherited from | Defined in |
|
|
51
|
+
| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
|
52
|
+
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | Actor with currentRoute signal and send method | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | play-router/dist/router-bridge-base.d.ts:55 |
|
|
53
|
+
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | play-router/dist/router-bridge-base.d.ts:61 |
|
|
54
|
+
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | play-router/dist/router-bridge-base.d.ts:60 |
|
|
55
|
+
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:63 |
|
|
56
|
+
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | play-router/dist/router-bridge-base.d.ts:62 |
|
|
57
|
+
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | Bidirectional route map for stateId ↔ path resolution | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | play-router/dist/router-bridge-base.d.ts:56 |
|
|
58
|
+
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:58 |
|
|
59
|
+
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | - | - | play-router/dist/router-bridge-base.d.ts:57 |
|
|
60
|
+
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | play-router/dist/router-bridge-base.d.ts:64 |
|
|
61
61
|
|
|
62
62
|
## Methods
|
|
63
63
|
|
|
@@ -112,7 +112,7 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
112
112
|
dispose(): void;
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
115
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L120)
|
|
116
116
|
|
|
117
117
|
Dispose the bridge (alias for disconnect).
|
|
118
118
|
|
|
@@ -190,7 +190,7 @@ Extracted query parameters or empty object
|
|
|
190
190
|
protected getInitialRouterPath(): string | null;
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
193
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L80)
|
|
194
194
|
|
|
195
195
|
Get the router's current path at connect() time for initial sync.
|
|
196
196
|
|
|
@@ -214,7 +214,7 @@ when the user cold-loads on a deep-link URL.
|
|
|
214
214
|
protected navigateRouter(path): void;
|
|
215
215
|
```
|
|
216
216
|
|
|
217
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
217
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L69)
|
|
218
218
|
|
|
219
219
|
Navigate TanStack Solid Router to the given path.
|
|
220
220
|
|
|
@@ -299,7 +299,7 @@ Prevents circular updates via isProcessingNavigation flag.
|
|
|
299
299
|
protected unwatchRouterChanges(): void;
|
|
300
300
|
```
|
|
301
301
|
|
|
302
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
302
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L112)
|
|
303
303
|
|
|
304
304
|
Stop watching TanStack Router changes.
|
|
305
305
|
|
|
@@ -319,7 +319,7 @@ Stop watching TanStack Router changes.
|
|
|
319
319
|
protected watchRouterChanges(): void;
|
|
320
320
|
```
|
|
321
321
|
|
|
322
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
322
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L98)
|
|
323
323
|
|
|
324
324
|
Subscribe to ALL navigation events via router.history.
|
|
325
325
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function PlayRouterProvider(props): any;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L17)
|
|
10
10
|
|
|
11
11
|
## Parameters
|
|
12
12
|
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
function createRouteMap(machine): RouteMap;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
|
|
10
10
|
|
|
11
11
|
Create a RouteMap from an XState machine
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
15
|
-
| Parameter | Type
|
|
16
|
-
| --------- |
|
|
17
|
-
| `machine` | `AnyStateMachine` | XState machine with route: {} config on states |
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --------- | ------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
17
|
+
| `machine` | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | XState machine with route: {} config on states |
|
|
18
18
|
|
|
19
19
|
## Returns
|
|
20
20
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: PlayRouterProviderProps
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L10)
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
8
|
|
|
9
9
|
| Property | Type | Defined in |
|
|
10
10
|
| ----------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
-
| <a id="property-actor"></a> `actor` | [`RoutableActor`](../type-aliases/RoutableActor.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
12
|
-
| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | [play-tanstack-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
13
|
-
| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
14
|
-
| <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
11
|
+
| <a id="property-actor"></a> `actor` | [`RoutableActor`](../type-aliases/RoutableActor.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L11) |
|
|
12
|
+
| <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | [play-tanstack-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L14) |
|
|
13
|
+
| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L13) |
|
|
14
|
+
| <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | [play-tanstack-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L12) |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Interface: RouteMapping
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
5
|
+
Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/types.ts#L19)
|
|
6
6
|
|
|
7
7
|
A single state ID ↔ path mapping entry for the TanStack Solid Router adapter.
|
|
8
8
|
|
|
@@ -19,5 +19,5 @@ const mapping: RouteMapping = { stateId: "#profile", path: "/profile/:userId" };
|
|
|
19
19
|
|
|
20
20
|
| Property | Modifier | Type | Description | Defined in |
|
|
21
21
|
| --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
-
| <a id="property-path"></a> `path` | `readonly` | `string` | TanStack Router path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-tanstack-solid-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
23
|
-
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., `"#home"`, `"#profile"`) | [play-tanstack-solid-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
22
|
+
| <a id="property-path"></a> `path` | `readonly` | `string` | TanStack Router path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-tanstack-solid-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/types.ts#L23) |
|
|
23
|
+
| <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., `"#home"`, `"#profile"`) | [play-tanstack-solid-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/types.ts#L21) |
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L7)
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type TanStackRouterInstance = ConstructorParameters<typeof SolidRouterBridge>[0];
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L8)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type TanStackRouterLike = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L28)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://g
|
|
|
16
16
|
history: object;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
19
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L31)
|
|
20
20
|
|
|
21
21
|
#### subscribe()
|
|
22
22
|
|
|
@@ -42,7 +42,7 @@ subscribe(handler): () => void;
|
|
|
42
42
|
optional state?: object;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
45
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L30)
|
|
46
46
|
|
|
47
47
|
#### location?
|
|
48
48
|
|
|
@@ -64,7 +64,7 @@ optional pathname?: string;
|
|
|
64
64
|
navigate(args): void;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
67
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L29)
|
|
68
68
|
|
|
69
69
|
#### Parameters
|
|
70
70
|
|