@xmachines/docs 1.0.0-beta.12 → 1.0.0-beta.13

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.
Files changed (132) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  6. package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
  7. package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
  8. package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
  9. package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
  10. package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
  11. package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
  12. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
  19. package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
  20. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  21. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  22. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  24. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  25. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  26. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  27. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
  29. package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
  30. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  31. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  32. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  33. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  34. package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
  35. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  36. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  37. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  38. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  39. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  40. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  41. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  42. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  43. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  44. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  45. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  46. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  47. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  48. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  49. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  50. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  51. package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
  52. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  53. package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
  54. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  56. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  57. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  59. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  60. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  61. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  62. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
  63. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  64. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  65. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  66. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  67. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  69. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  70. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  71. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  72. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  73. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  74. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  75. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  76. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  77. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  78. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  79. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  80. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  81. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  82. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  83. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  84. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  85. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  86. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  87. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  88. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  89. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  90. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  91. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  92. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
  93. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  94. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  95. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  96. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
  97. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  99. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  100. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  102. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  103. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  104. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  105. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  106. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  107. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  108. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  109. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  110. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  111. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  112. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  113. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  114. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  115. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  116. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
  117. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  118. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  119. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  120. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  121. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  122. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  123. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  124. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  125. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  126. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  127. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  128. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  129. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  130. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  131. package/api/README.md +12 -12
  132. 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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L78)
5
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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,7 +47,7 @@ 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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L88)
50
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L88)
51
51
 
52
52
  Create TanStack React Router bridge
53
53
 
@@ -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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L110)
199
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:110](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L100)
222
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L131)
310
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L123)
332
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/play-router-provider.tsx#L38)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/route-map.ts#L73)
9
+ Defined in: [play-tanstack-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/extract-params.ts#L29)
9
+ Defined in: [play-tanstack-react-router/src/extract-params.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/extract-params.ts#L68)
9
+ Defined in: [play-tanstack-react-router/src/extract-params.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
5
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-react-router/src/play-router-provider.tsx#L28)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/play-router-provider.tsx#L30) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/route-map.ts#L22)
5
+ Defined in: [play-tanstack-react-router/src/route-map.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/route-map.ts#L24) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/types.ts#L21)
5
+ Defined in: [play-tanstack-react-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/types.ts#L23) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/play-router-provider.tsx#L26)
9
+ Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L42)
9
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L45)
19
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L44)
45
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
67
+ Defined in: [play-tanstack-react-router/src/tanstack-router-bridge.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-react-router/src/tanstack-router-bridge.ts#L43)
68
68
 
69
69
  #### Parameters
70
70
 
@@ -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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/route-map.ts#L26)
5
+ Defined in: [play-tanstack-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L45)
5
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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,7 +25,7 @@ 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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L55)
28
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L55)
29
29
 
30
30
  Create a TanStack Solid Router bridge
31
31
 
@@ -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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L120)
115
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L80)
193
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L69)
217
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L112)
302
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L98)
322
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L17)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L17)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,7 +6,7 @@
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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
9
+ Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
10
10
 
11
11
  Create a RouteMap from an XState machine
12
12
 
@@ -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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L10)
5
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L12) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/types.ts#L19)
5
+ Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/types.ts#L21) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L7)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L8)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L28)
9
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L31)
19
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L30)
45
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L29)
67
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L29)
68
68
 
69
69
  #### Parameters
70
70
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps
4
4
 
5
- Defined in: [types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue/src/types.ts#L17)
5
+ Defined in: [types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue/src/types.ts#L17)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
@@ -10,5 +10,5 @@ Props for PlayRenderer component
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue/src/types.ts#L19) |
14
- | <a id="property-components"></a> `components` | `Record`\<`string`, `Component`\> | Map of component names to Vue components | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue/src/types.ts#L22) |
13
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue/src/types.ts#L19) |
14
+ | <a id="property-components"></a> `components` | `Record`\<`string`, `Component`\> | Map of component names to Vue components | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue/src/types.ts#L22) |
@@ -6,4 +6,4 @@
6
6
  const PlayRenderer: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue/src/vue-shim.d.ts#L3)
9
+ Defined in: [vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue/src/vue-shim.d.ts#L3)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-vue-router/src/route-map.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/route-map.ts#L14)
5
+ Defined in: [play-vue-router/src/route-map.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/route-map.ts#L14)
6
6
 
7
7
  VueBaseRouteMap — intermediate base class for Vue Router adapters.
8
8
 
@@ -40,7 +40,7 @@ class MyVueRouteMap extends VueBaseRouteMap {
40
40
  new RouteMap(mappings): RouteMap;
41
41
  ```
42
42
 
43
- Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L32)
43
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L32)
44
44
 
45
45
  #### Parameters
46
46
 
@@ -99,7 +99,7 @@ map.getPathByStateId("missing"); // null
99
99
  getPattern(stateId): string | undefined;
100
100
  ```
101
101
 
102
- Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L58)
102
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L58)
103
103
 
104
104
  Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
105
105
 
@@ -125,7 +125,7 @@ Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
125
125
  getRouteName(stateId): string | undefined;
126
126
  ```
127
127
 
128
- Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L48)
128
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L48)
129
129
 
130
130
  Get the Vue Router route name for a given state ID.
131
131
 
@@ -151,7 +151,7 @@ Get the Vue Router route name for a given state ID.
151
151
  getStateId(routeName): string | undefined;
152
152
  ```
153
153
 
154
- Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L53)
154
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L53)
155
155
 
156
156
  Get the state ID for a given Vue Router route name.
157
157
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueBaseRouteMap
4
4
 
5
- Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L28)
5
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L28)
6
6
 
7
7
  VueBaseRouteMap — intermediate base class for Vue Router adapters.
8
8
 
@@ -44,7 +44,7 @@ class MyVueRouteMap extends VueBaseRouteMap {
44
44
  new VueBaseRouteMap(mappings): VueBaseRouteMap;
45
45
  ```
46
46
 
47
- Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L32)
47
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L32)
48
48
 
49
49
  #### Parameters
50
50
 
@@ -103,7 +103,7 @@ map.getPathByStateId("missing"); // null
103
103
  getPattern(stateId): string | undefined;
104
104
  ```
105
105
 
106
- Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L58)
106
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L58)
107
107
 
108
108
  Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
109
109
 
@@ -125,7 +125,7 @@ Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
125
125
  getRouteName(stateId): string | undefined;
126
126
  ```
127
127
 
128
- Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L48)
128
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L48)
129
129
 
130
130
  Get the Vue Router route name for a given state ID.
131
131
 
@@ -147,7 +147,7 @@ Get the Vue Router route name for a given state ID.
147
147
  getStateId(routeName): string | undefined;
148
148
  ```
149
149
 
150
- Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-base-route-map.ts#L53)
150
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-base-route-map.ts#L53)
151
151
 
152
152
  Get the state ID for a given Vue Router route name.
153
153
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueRouterBridge
4
4
 
5
- Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L32)
5
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L32)
6
6
 
7
7
  @xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
8
8
 
@@ -23,7 +23,7 @@ new VueRouterBridge(
23
23
  vueRouteMap): VueRouterBridge;
24
24
  ```
25
25
 
26
- Defined in: [play-vue-router/src/vue-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L109)
26
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L109)
27
27
 
28
28
  Create a Vue Router bridge
29
29
 
@@ -73,7 +73,7 @@ onUnmounted(() => bridge.disconnect());
73
73
  connect(): void;
74
74
  ```
75
75
 
76
- Defined in: [play-vue-router/src/vue-router-bridge.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L229)
76
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L229)
77
77
 
78
78
  Override base class connect() to add Vue-native initial router → actor sync.
79
79
 
@@ -128,7 +128,7 @@ Stops signal watching and unregisters framework-specific router listener.
128
128
  dispose(): void;
129
129
  ```
130
130
 
131
- Defined in: [play-vue-router/src/vue-router-bridge.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L275)
131
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L275)
132
132
 
133
133
  Cleanup alias for component lifecycle integration.
134
134
 
@@ -212,7 +212,7 @@ Extracted query parameters or empty object
212
212
  protected getInitialRouterPath(): string | null;
213
213
  ```
214
214
 
215
- Defined in: [play-vue-router/src/vue-router-bridge.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L263)
215
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:263](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L263)
216
216
 
217
217
  Return null to suppress base class initial sync — VueRouterBridge handles it
218
218
  in connect() using the Vue-native named-route lookup instead.
@@ -233,7 +233,7 @@ in connect() using the Vue-native named-route lookup instead.
233
233
  protected navigateRouter(path): void;
234
234
  ```
235
235
 
236
- Defined in: [play-vue-router/src/vue-router-bridge.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L126)
236
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L126)
237
237
 
238
238
  Navigate Vue Router to the given path/stateId.
239
239
 
@@ -321,7 +321,7 @@ Prevents circular updates via isProcessingNavigation flag.
321
321
  protected unwatchRouterChanges(): void;
322
322
  ```
323
323
 
324
- Defined in: [play-vue-router/src/vue-router-bridge.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L209)
324
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L209)
325
325
 
326
326
  Unsubscribe from Vue Router afterEach guard.
327
327
 
@@ -341,7 +341,7 @@ Unsubscribe from Vue Router afterEach guard.
341
341
  protected watchRouterChanges(): void;
342
342
  ```
343
343
 
344
- Defined in: [play-vue-router/src/vue-router-bridge.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/63cf57d981b7c254077a8fd4bdecb76e2f07040c/packages/play-vue-router/src/vue-router-bridge.ts#L150)
344
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-vue-router/src/vue-router-bridge.ts#L150)
345
345
 
346
346
  Subscribe to Vue Router changes using afterEach guard.
347
347