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

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 (334) hide show
  1. package/api/@xmachines/play/classes/NonNullableError.md +4 -4
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  4. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  6. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +1 -1
  7. package/api/@xmachines/play-actor/functions/toAtomState.md +1 -1
  8. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  9. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  10. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  11. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  12. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  13. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  14. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -28
  15. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  16. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  18. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  19. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  20. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -16
  23. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  24. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  25. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -9
  26. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +11 -14
  27. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
  28. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  30. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  31. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  34. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  36. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  39. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  41. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  42. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  44. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  45. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  46. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  47. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  48. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  49. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  50. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  51. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  53. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  54. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  55. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  56. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  57. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  58. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  59. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  60. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  61. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  63. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  64. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  65. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  66. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  67. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  68. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  69. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +4 -378
  71. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  72. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +1 -1
  73. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  74. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  75. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +5 -5
  76. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  77. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  78. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  79. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  80. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  81. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  82. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  83. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +1 -1
  84. package/api/@xmachines/play-router/README.md +6 -2
  85. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  86. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +4 -353
  87. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  88. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  89. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  90. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  91. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +4 -4
  92. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  93. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  94. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  95. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  96. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  97. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  98. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  99. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  100. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  101. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  102. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  103. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  104. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  105. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  106. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  107. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  108. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  109. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  110. package/api/@xmachines/play-router/interfaces/PlayActor.md +5 -5
  111. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  112. package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
  113. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  114. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  115. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  116. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  117. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  118. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  119. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  120. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  121. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  122. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  123. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  124. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  125. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  126. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  127. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  128. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  129. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  130. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  131. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  132. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  133. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  134. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  135. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  136. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  137. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  138. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  139. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  140. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  141. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  142. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  143. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +5 -367
  145. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +1 -1
  146. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  147. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  148. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +5 -5
  149. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  150. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  151. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  152. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  153. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  154. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  155. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  156. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  157. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  158. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +1 -1
  159. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  160. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  161. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  162. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  163. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  164. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  165. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  166. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  167. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  168. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  169. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  170. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  171. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  172. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  173. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  174. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  175. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  176. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  177. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  178. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  179. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  180. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  182. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  183. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  184. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  185. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  186. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  187. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  188. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  189. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +4 -384
  190. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +1 -1
  191. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  192. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  193. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  194. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +5 -5
  195. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  196. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  197. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  198. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  199. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  200. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  201. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  202. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  203. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  204. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  205. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +1 -1
  206. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +2 -382
  207. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  208. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +4 -4
  209. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  210. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +5 -385
  211. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +1 -1
  212. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  213. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +5 -5
  214. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  215. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +5 -5
  216. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  217. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  218. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  219. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  220. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +1 -1
  221. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  222. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  223. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  224. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +1 -1
  225. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  226. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  227. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  228. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  229. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  230. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  231. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  232. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  233. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  234. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  235. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  236. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  237. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  238. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +5 -405
  239. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  240. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +5 -5
  241. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  242. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  243. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  244. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  245. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  246. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  247. package/api/@xmachines/play-xstate/classes/PlayerActor.md +22 -24
  248. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  249. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  250. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  251. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  252. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  253. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  254. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  255. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  256. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  257. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  258. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  259. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  260. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  261. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  262. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  263. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  264. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  265. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  266. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  267. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  268. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  269. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  270. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  271. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  272. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  273. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  274. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  275. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +2 -2
  276. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +1 -1
  277. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  278. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +4 -4
  279. package/contributing/testing.md +4 -4
  280. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  281. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  282. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  283. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  284. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  285. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  286. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  287. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  288. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  289. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  290. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  291. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  292. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  293. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  294. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  295. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  296. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  297. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  298. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  299. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  300. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  301. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  302. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  303. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  304. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  305. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  306. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  307. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  308. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  309. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  310. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  311. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  312. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  313. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  314. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  315. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  316. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  317. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  318. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  319. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  320. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  321. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  322. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  323. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  324. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  325. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  326. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  327. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  328. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  329. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  330. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  331. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  332. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  333. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  334. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L101)
5
+ Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L101)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -57,7 +57,7 @@ map.getPathByStateId("missing"); // null
57
57
  new RouteMap(mappings, options?): RouteMap;
58
58
  ```
59
59
 
60
- Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L127)
60
+ Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L127)
61
61
 
62
62
  Build a route map from an array of state ID ↔ path mappings.
63
63
 
@@ -85,7 +85,7 @@ buckets for efficient candidate selection.
85
85
  getPathByStateId(stateId): string | null;
86
86
  ```
87
87
 
88
- Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L218)
88
+ Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L218)
89
89
 
90
90
  Look up the path pattern registered for a state ID.
91
91
 
@@ -121,7 +121,7 @@ map.getPathByStateId("missing"); // null
121
121
  getStateIdByPath(path): string | null;
122
122
  ```
123
123
 
124
- Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L178)
124
+ Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/base-route-map.ts#L178)
125
125
 
126
126
  Resolve a URL path to its mapped state ID.
127
127
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: TanStackSolidRouterBridge
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L42)
5
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L42)
6
6
 
7
7
  TanStack Solid Router adapter implementing RouterBridge protocol via TanStackRouterBridgeBase
8
8
 
@@ -30,7 +30,7 @@ new TanStackSolidRouterBridge(
30
30
  routeMap): TanStackSolidRouterBridge;
31
31
  ```
32
32
 
33
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
33
+ Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
34
34
 
35
35
  Create a TanStack Router bridge
36
36
 
@@ -50,21 +50,6 @@ Create a TanStack Router bridge
50
50
 
51
51
  [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`constructor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#constructor)
52
52
 
53
- ## Properties
54
-
55
- | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
56
- | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
57
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | `undefined` | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`actor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L124) |
58
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`hasConnectedOnce`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L99) |
59
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`isConnected`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L98) |
60
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`isProcessingNavigation`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L111) |
61
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`lastSyncedPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L100) |
62
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. `getPathByStateId` may be keyed on either the `"#stateId"` or the bare `"stateId"` form — both forms are tried automatically by the bridge, so custom implementations (e.g. plain test objects) need only handle one. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`routeMap`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L125) |
63
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L127) |
64
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L126) |
65
- | <a id="property-router"></a> `router` | `readonly` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | `undefined` | TanStack Router instance (from `createRouter`) | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`router`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-router) | [play-tanstack-router/src/tanstack-router-bridge-base.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L113) |
66
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`routeWatcher`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L112) |
67
-
68
53
  ## Methods
69
54
 
70
55
  ### connect()
@@ -73,7 +58,7 @@ Create a TanStack Router bridge
73
58
  connect(): void;
74
59
  ```
75
60
 
76
- Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L151)
61
+ Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L151)
77
62
 
78
63
  Connect the router bridge to the Actor.
79
64
 
@@ -105,7 +90,7 @@ Adapters that need custom initial-sync behavior should override
105
90
  disconnect(): void;
106
91
  ```
107
92
 
108
- Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L256)
93
+ Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/router-bridge-base.ts#L256)
109
94
 
110
95
  Disconnect the router bridge from the Actor.
111
96
 
@@ -127,375 +112,10 @@ Stops signal watching and unregisters framework-specific router listener.
127
112
  dispose(): void;
128
113
  ```
129
114
 
130
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L46)
115
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L46)
131
116
 
132
117
  Dispose the bridge (alias for disconnect).
133
118
 
134
119
  #### Returns
135
120
 
136
121
  `void`
137
-
138
- ---
139
-
140
- ### extractParams()
141
-
142
- ```ts
143
- protected extractParams(pathname, stateId): Record<string, string>;
144
- ```
145
-
146
- Defined in: [play-router/src/router-bridge-base.ts:423](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L423)
147
-
148
- Extract path parameters from URL using the URLPattern API.
149
-
150
- Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
151
- library. If `URLPattern` is unavailable and the matched route has parameterized
152
- segments, a `URLPatternUnavailableError` is thrown — callers must provide a polyfill
153
- for environments without native URLPattern support (Node.js < 24, older browsers).
154
-
155
- #### Parameters
156
-
157
- | Parameter | Type | Description |
158
- | ---------- | -------- | ----------------------------------------------------- |
159
- | `pathname` | `string` | The actual URL path (e.g., '/profile/john') |
160
- | `stateId` | `string` | The matched state ID for looking up the route pattern |
161
-
162
- #### Returns
163
-
164
- `Record`\<`string`, `string`\>
165
-
166
- Extracted path parameters, or empty object if no match
167
-
168
- #### Throws
169
-
170
- When URLPattern is absent and the route is parameterized
171
-
172
- #### Inherited from
173
-
174
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`extractParams`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#extractparams)
175
-
176
- ---
177
-
178
- ### extractQuery()
179
-
180
- ```ts
181
- protected extractQuery(search): Record<string, string>;
182
- ```
183
-
184
- Defined in: [play-router/src/router-bridge-base.ts:480](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L480)
185
-
186
- Extract query parameters from URL search string.
187
-
188
- #### Parameters
189
-
190
- | Parameter | Type | Description |
191
- | --------- | -------- | ------------------------------------------------ |
192
- | `search` | `string` | URL search string (e.g., '?tab=security&page=1') |
193
-
194
- #### Returns
195
-
196
- `Record`\<`string`, `string`\>
197
-
198
- Extracted query parameters or empty object
199
-
200
- #### Inherited from
201
-
202
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`extractQuery`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#extractquery)
203
-
204
- ---
205
-
206
- ### getInitialRouterPath()
207
-
208
- ```ts
209
- protected getInitialRouterPath(): string | null;
210
- ```
211
-
212
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L153)
213
-
214
- Read the router's current pathname for initial sync.
215
-
216
- Called once in connect() to handle cold-load / deep-link scenarios where
217
- the URL differs from the actor's initial state (e.g. user pastes /dashboard
218
- while logged out — the actor must be redirected to /login before rendering).
219
-
220
- Uses `router.history.location.pathname` — reflects `window.location` immediately,
221
- before the router has been loaded or a `<RouterProvider>` mounted.
222
- `router.state.location` is only populated after `router.load()` which may not
223
- have run yet when the bridge first connects in a component effect.
224
-
225
- The base class `connect()` uses `actor.initialRoute` to distinguish:
226
-
227
- - **Deep-link:** router URL differs from machine's initial route → router wins.
228
- - **Restore:** router at machine's initial route, actor at a different restored
229
- route → actor wins, bridge pushes actor's restored route to the router.
230
-
231
- #### Returns
232
-
233
- `string` \| `null`
234
-
235
- #### Inherited from
236
-
237
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`getInitialRouterPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#getinitialrouterpath)
238
-
239
- ---
240
-
241
- ### getInitialRouterSearch()
242
-
243
- ```ts
244
- protected getInitialRouterSearch(): string | undefined;
245
- ```
246
-
247
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L169)
248
-
249
- Return the initial URL search string for query-param forwarding on `connect()`.
250
-
251
- Reads `router.history.location.search` — the same source used by
252
- `getInitialRouterPath()`, which reflects `window.location` immediately before
253
- `router.load()` or `<RouterProvider>` mounts. An empty string returns `undefined`
254
- so `syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
255
-
256
- #### Returns
257
-
258
- `string` \| `undefined`
259
-
260
- #### Inherited from
261
-
262
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`getInitialRouterSearch`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#getinitialroutersearch)
263
-
264
- ---
265
-
266
- ### navigateRouter()
267
-
268
- ```ts
269
- protected navigateRouter(path): void;
270
- ```
271
-
272
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L131)
273
-
274
- Navigate TanStack Router to the given path.
275
-
276
- Calls `router.load()` (fire-and-forget) after `navigate` so TanStack re-runs
277
- route matching and loaders — `navigate` alone does not when no
278
- `<RouterProvider>` (Transitioner) is mounted.
279
-
280
- #### Parameters
281
-
282
- | Parameter | Type |
283
- | --------- | -------- |
284
- | `path` | `string` |
285
-
286
- #### Returns
287
-
288
- `void`
289
-
290
- #### Inherited from
291
-
292
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`navigateRouter`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#navigaterouter)
293
-
294
- ---
295
-
296
- ### resolveNavigationPath()
297
-
298
- ```ts
299
- protected resolveNavigationPath(route): string | null;
300
- ```
301
-
302
- Defined in: [play-router/src/router-bridge-base.ts:447](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L447)
303
-
304
- Resolve an actor route value to a concrete URL path for navigation.
305
-
306
- Bridges that receive raw `actor.currentRoute` values in `navigateRouter`
307
- can call this to normalize stateIds (with or without `#` prefix) to paths.
308
- Returns `null` when navigation is not possible:
309
-
310
- - unknown stateId with no route map entry
311
- - parameterized or wildcard pattern (e.g. `/profile/:id`, `/docs/*`) — no
312
- concrete values available to build a real URL
313
- - non-path string that isn't a known stateId
314
-
315
- StateId lookups try both the `"#stateId"` and bare `"stateId"` forms
316
- automatically (via `lookupPathByStateId`), so custom route maps keyed on
317
- only one form still resolve.
318
-
319
- #### Parameters
320
-
321
- | Parameter | Type | Description |
322
- | --------- | -------- | -------------------------------------------------------------- |
323
- | `route` | `string` | Raw actor route value (stateId, `#`-stateId, or concrete path) |
324
-
325
- #### Returns
326
-
327
- `string` \| `null`
328
-
329
- Concrete URL path, or `null` if navigation should be skipped
330
-
331
- #### Inherited from
332
-
333
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`resolveNavigationPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#resolvenavigationpath)
334
-
335
- ---
336
-
337
- ### sanitizePath()
338
-
339
- ```ts
340
- protected sanitizePath(pathname): string | null;
341
- ```
342
-
343
- Defined in: [play-router/src/router-bridge-base.ts:513](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L513)
344
-
345
- Sanitize and validate a raw URL pathname received from the router.
346
-
347
- Applies the path-length cap (2048 chars), strips query strings and fragments
348
- that may have been included in the pathname segment, and normalises
349
- consecutive slashes.
350
-
351
- Implementations that bypass `syncActorFromRouter()` (e.g. when using
352
- framework-native reactive watchers that receive pre-parsed route objects)
353
- MUST call this method before passing the path to any route-map lookup.
354
- `syncActorFromRouter()` calls this internally, so bridges that delegate
355
- to it do not need to call `sanitizePath` themselves.
356
-
357
- #### Parameters
358
-
359
- | Parameter | Type | Description |
360
- | ---------- | -------- | ------------------------------------------- |
361
- | `pathname` | `string` | Raw URL pathname from the framework router. |
362
-
363
- #### Returns
364
-
365
- `string` \| `null`
366
-
367
- Sanitized pathname, or `null` if the path is invalid / too long.
368
-
369
- #### Inherited from
370
-
371
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`sanitizePath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#sanitizepath)
372
-
373
- ---
374
-
375
- ### syncActorFromRouter()
376
-
377
- ```ts
378
- protected syncActorFromRouter(pathname, search?): void;
379
- ```
380
-
381
- Defined in: [play-router/src/router-bridge-base.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L347)
382
-
383
- Sync actor state when router location changes.
384
-
385
- **Known path:** sends a `play.route` event to the actor with the matched
386
- stateId, params, and query. Prevents circular updates via the
387
- `isProcessingNavigation` flag.
388
-
389
- **Unknown/unmapped path:** does NOT send a `play.route` event (actor state
390
- is unchanged). Instead, actively corrects the browser URL by calling
391
- `navigateRouter(actor.currentRoute.get())` — keeping the URL in sync with
392
- actor state even when the user types an invalid path into the address bar
393
- or pushes one programmatically mid-session. `lastSyncedPath` is set to the
394
- resolved concrete path before calling `navigateRouter` so the router's own
395
- callback for that navigation short-circuits the echo-suppression guard and
396
- sends no spurious event.
397
-
398
- #### Parameters
399
-
400
- | Parameter | Type |
401
- | ---------- | -------- |
402
- | `pathname` | `string` |
403
- | `search?` | `string` |
404
-
405
- #### Returns
406
-
407
- `void`
408
-
409
- #### Inherited from
410
-
411
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`syncActorFromRouter`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#syncactorfromrouter)
412
-
413
- ---
414
-
415
- ### syncRouterFromActor()
416
-
417
- ```ts
418
- protected syncRouterFromActor(route): void;
419
- ```
420
-
421
- Defined in: [play-router/src/router-bridge-base.ts:302](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L302)
422
-
423
- Sync router location when actor route signal changes.
424
-
425
- Resolves the actor route to a concrete URL path and calls navigateRouter()
426
- for framework-specific navigation. When the route cannot be resolved
427
- (unknown stateId, parameterized pattern with no concrete values) the push
428
- is skipped entirely — `navigateRouter` is never called with a raw stateId
429
- or pattern.
430
-
431
- Echo suppression — preventing the router's own callback from re-driving the
432
- actor — is handled entirely by `lastSyncedPath`: it is set to the resolved
433
- path before `navigateRouter()` is called, so any `syncActorFromRouter`
434
- invocation for the same path short-circuits at the
435
- `sanitized === lastSyncedPath` check and sends no event regardless of
436
- whether the callback fires synchronously or asynchronously.
437
-
438
- `isProcessingNavigation` is NOT set here — it is only used inside
439
- `syncActorFromRouter` to guard against re-entrant guard-redirect loops.
440
-
441
- #### Parameters
442
-
443
- | Parameter | Type |
444
- | --------- | --------- |
445
- | `route` | `unknown` |
446
-
447
- #### Returns
448
-
449
- `void`
450
-
451
- #### Inherited from
452
-
453
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`syncRouterFromActor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#syncrouterfromactor)
454
-
455
- ---
456
-
457
- ### unwatchRouterChanges()
458
-
459
- ```ts
460
- protected unwatchRouterChanges(): void;
461
- ```
462
-
463
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:196](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L196)
464
-
465
- Stop watching TanStack Router changes.
466
-
467
- #### Returns
468
-
469
- `void`
470
-
471
- #### Inherited from
472
-
473
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`unwatchRouterChanges`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#unwatchrouterchanges)
474
-
475
- ---
476
-
477
- ### watchRouterChanges()
478
-
479
- ```ts
480
- protected watchRouterChanges(): void;
481
- ```
482
-
483
- Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L184)
484
-
485
- Subscribe to ALL navigation events via router.history.
486
-
487
- router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
488
- covering both link clicks and browser back/forward button presses.
489
-
490
- The subscriber callback receives { location, action } where location is the
491
- new history location with pathname and search already updated. It calls
492
- `router.load()` (fire-and-forget) so TanStack re-runs matching/loaders for the
493
- new location, mirroring what Transitioner does when `<RouterProvider>` is mounted.
494
-
495
- #### Returns
496
-
497
- `void`
498
-
499
- #### Inherited from
500
-
501
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`watchRouterChanges`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#watchrouterchanges)
@@ -6,7 +6,7 @@
6
6
  function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L76)
9
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L76)
10
10
 
11
11
  Create a Solid `PlayRouterProvider` component bound to a specific bridge class.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine, options?): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L45)
9
+ Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/create-route-map.ts#L45)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L297)
5
+ Defined in: [play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
8
  adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L269)
52
+ Defined in: [play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L225)
5
+ Defined in: [play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -122,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
122
122
 
123
123
  | Property | Modifier | Type | Defined in |
124
124
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
125
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L230) |
126
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L228) |
127
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L229) |
128
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L227) |
129
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-router/src/types.ts#L226) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderBaseProps\<TRouter, TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L45)
5
+ Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L45)
6
6
 
7
7
  Props shared by every factory-created Solid `PlayRouterProvider`.
8
8
 
@@ -25,7 +25,7 @@ router type (e.g. `TanStackRouterInstance` in
25
25
 
26
26
  | Property | Type | Description | Defined in |
27
27
  | ----------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
29
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
30
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
31
- | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
28
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
29
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
30
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
31
+ | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L29)
5
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L29)
6
6
 
7
7
  Props for the TanStack Solid Router `PlayRouterProvider`.
8
8
 
@@ -22,7 +22,7 @@ Props for the TanStack Solid Router `PlayRouterProvider`.
22
22
 
23
23
  | Property | Type | Description | Inherited from | Defined in |
24
24
  | ----------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
26
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
27
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
28
- | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |
25
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L47) |
26
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L53) |
27
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L51) |
28
+ | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [play-tanstack-solid-router/src/create-play-router-provider.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.55/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L49) |