@xmachines/docs 1.0.0-beta.36 → 1.0.0-beta.38

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 (293) 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/typedSpec.md +1 -1
  7. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  8. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  9. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  10. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  11. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  12. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  13. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  14. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  15. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  16. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  17. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  18. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  19. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +13 -13
  20. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +6 -6
  21. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  22. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +12 -12
  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 +5 -5
  26. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +5 -5
  27. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  28. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  29. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  30. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  31. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  34. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  38. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  39. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  40. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  41. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  42. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  43. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  44. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  45. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  46. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  47. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  48. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  49. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  50. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  51. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  52. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  53. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  54. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  55. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  56. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  57. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  58. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  59. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  60. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  61. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  62. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  63. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  64. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  65. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  66. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  67. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  68. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  69. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  70. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  71. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  72. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  73. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  74. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  75. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  76. package/api/@xmachines/play-router/classes/RouteMap.md +4 -4
  77. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  78. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  79. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  80. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  81. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  82. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  83. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  84. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  85. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  86. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  87. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  88. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  89. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  90. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  91. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  92. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  93. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  94. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  95. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  96. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  97. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  98. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  99. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  100. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  101. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  102. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  103. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  104. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  105. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  106. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +4 -4
  107. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  108. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  109. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  110. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  111. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  112. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  113. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  114. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  115. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  116. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  117. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  118. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  119. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  120. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  121. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  122. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  123. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  124. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  125. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  126. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  127. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  128. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  129. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  130. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  131. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  132. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  133. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  134. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  135. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  136. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  137. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  138. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  139. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  140. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  141. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  142. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  143. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  144. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  145. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  146. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  147. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  148. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +4 -4
  149. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  150. package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +1 -1
  151. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  152. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  153. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  154. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  155. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  156. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  157. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  158. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  159. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  160. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  161. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  162. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  163. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  164. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  165. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  166. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  167. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  168. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  169. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  170. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  171. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  172. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  173. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  174. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  175. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  176. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  177. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  178. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  179. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  180. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  181. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  182. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  183. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  184. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  185. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  186. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  187. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  188. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  189. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  190. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  191. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  192. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  193. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  194. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  195. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  196. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  197. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  198. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  199. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  200. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  201. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  202. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  203. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  204. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  205. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  206. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  207. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  208. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  209. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  210. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  211. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  212. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  213. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  214. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  215. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  216. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  217. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  218. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  219. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  220. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  221. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  222. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  223. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  224. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  225. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  226. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  227. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  228. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  229. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  230. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  231. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  232. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  233. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  234. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +1 -1
  235. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  236. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  237. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  238. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  239. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  240. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  241. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  242. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  243. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  244. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  245. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  246. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  247. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  248. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  249. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  250. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  251. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  252. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  253. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  254. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  255. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  256. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  257. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  258. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  259. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  260. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  261. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  262. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  263. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  264. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  265. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  266. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  267. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  268. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  269. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  270. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  271. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  272. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  273. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  274. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  275. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  276. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  277. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  278. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  279. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  280. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  281. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  282. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  283. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  284. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  285. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  286. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  287. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  288. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  289. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  290. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  291. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  292. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  293. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DefineRegistryResult
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:334](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L334)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:334](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L334)
6
6
 
7
7
  Result returned by `defineRegistry`.
8
8
 
@@ -12,6 +12,6 @@ Matches `DefineRegistryResult` from @json-render/react, /solid, /svelte, /vue.
12
12
 
13
13
  | Property | Type | Description | Defined in |
14
14
  | --------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15
- | <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\> | Execute a named action by name, with optional params. Mirrors `executeAction` on `DefineRegistryResult` from @json-render/react, /solid, /vue, /svelte. Useful for programmatically triggering actions outside of the emit/on flow. | [packages/play-dom/src/json-render/types.ts:364](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L364) |
16
- | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions (called lazily at action-invocation time) so handlers always see the latest setState and state snapshot — matching the pattern from the framework renderers. In `PlayRenderer`, these are wired automatically from the xstate store. Pass `() => undefined, () => ({})` only in tests or when state management is not needed. | [packages/play-dom/src/json-render/types.ts:349](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L349) |
17
- | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [packages/play-dom/src/json-render/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L338) |
15
+ | <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\> | Execute a named action by name, with optional params. Mirrors `executeAction` on `DefineRegistryResult` from @json-render/react, /solid, /vue, /svelte. Useful for programmatically triggering actions outside of the emit/on flow. | [packages/play-dom/src/json-render/types.ts:364](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L364) |
16
+ | <a id="property-handlers"></a> `handlers` | (`getSetState`, `getState`) => `Record`\<`string`, `ActionHandler`\> | Create ActionProvider-compatible handlers. Accepts getter functions (called lazily at action-invocation time) so handlers always see the latest setState and state snapshot — matching the pattern from the framework renderers. In `PlayRenderer`, these are wired automatically from the xstate store. Pass `() => undefined, () => ({})` only in tests or when state management is not needed. | [packages/play-dom/src/json-render/types.ts:349](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L349) |
17
+ | <a id="property-registry"></a> `registry` | [`DomRegistry`](../type-aliases/DomRegistry.md) | The built `DomRegistry`, ready to pass to `connectRenderer` or `PlayRenderer`. | [packages/play-dom/src/json-render/types.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L338) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: DomRenderContext
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L128)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L128)
6
6
 
7
7
  Low-level render context passed to each `DomComponentRenderer`.
8
8
 
@@ -10,14 +10,14 @@ Low-level render context passed to each `DomComponentRenderer`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [packages/play-dom/src/json-render/types.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L142) |
14
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Optional map of named compute functions, forwarded to PropResolutionContext. Enables { $computed: "funcName", args: {...} } prop expressions to resolve. Mirrors the `functions` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L149) |
15
- | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [packages/play-dom/src/json-render/types.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L136) |
16
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Component implementations can use this to show skeleton/loading states. When loading=true, missing-child warnings are suppressed. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L157) |
17
- | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [packages/play-dom/src/json-render/types.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L138) |
18
- | <a id="property-repeatbasepath"></a> `repeatBasePath?` | `string` | Absolute JSON Pointer path to the current repeat item (e.g. "/todos/0"). Mirrors `repeatBasePath` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L172) |
19
- | <a id="property-repeatindex"></a> `repeatIndex?` | `number` | Current repeat array index when inside a repeat scope. Mirrors `repeatIndex` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L167) |
20
- | <a id="property-repeatitem"></a> `repeatItem?` | `unknown` | Current repeat item when inside a repeat scope. Mirrors `repeatItem` in `@json-render/core`'s `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L162) |
21
- | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [packages/play-dom/src/json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L134) |
22
- | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [packages/play-dom/src/json-render/types.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L130) |
23
- | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [packages/play-dom/src/json-render/types.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L132) |
13
+ | <a id="property-elementbindings"></a> `elementBindings?` | `Record`\<`string`, `string`\> | Pre-computed two-way binding paths for this element's props. | [packages/play-dom/src/json-render/types.ts:142](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L142) |
14
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Optional map of named compute functions, forwarded to PropResolutionContext. Enables { $computed: "funcName", args: {...} } prop expressions to resolve. Mirrors the `functions` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L149) |
15
+ | <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Map of json-render catalog action names → async ActionHandler functions. | [packages/play-dom/src/json-render/types.ts:136](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L136) |
16
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Component implementations can use this to show skeleton/loading states. When loading=true, missing-child warnings are suppressed. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/json-render/types.ts:157](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L157) |
17
+ | <a id="property-renderchildren"></a> `renderChildren` | (`keys`) => `Node`[] | Render a list of child element keys into DOM nodes. | [packages/play-dom/src/json-render/types.ts:138](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L138) |
18
+ | <a id="property-repeatbasepath"></a> `repeatBasePath?` | `string` | Absolute JSON Pointer path to the current repeat item (e.g. "/todos/0"). Mirrors `repeatBasePath` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L172) |
19
+ | <a id="property-repeatindex"></a> `repeatIndex?` | `number` | Current repeat array index when inside a repeat scope. Mirrors `repeatIndex` in `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L167) |
20
+ | <a id="property-repeatitem"></a> `repeatItem?` | `unknown` | Current repeat item when inside a repeat scope. Mirrors `repeatItem` in `@json-render/core`'s `PropResolutionContext`. | [packages/play-dom/src/json-render/types.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L162) |
21
+ | <a id="property-send"></a> `send` | (`event`) => `void` | Dispatch an event (e.g. to an XState actor). | [packages/play-dom/src/json-render/types.ts:134](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L134) |
22
+ | <a id="property-spec"></a> `spec` | `Spec` | Full spec tree for this render pass. | [packages/play-dom/src/json-render/types.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L130) |
23
+ | <a id="property-store"></a> `store` | `StateStore` | Live state store bound to `spec.state`. | [packages/play-dom/src/json-render/types.ts:132](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L132) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: EventHandle
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L112)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L112)
6
6
 
7
7
  Handle returned by `ComponentContext.on(eventName)`.
8
8
 
@@ -10,6 +10,6 @@ Handle returned by `ComponentContext.on(eventName)`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [packages/play-dom/src/json-render/types.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L120) |
14
- | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [packages/play-dom/src/json-render/types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L114) |
15
- | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [packages/play-dom/src/json-render/types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L118) |
13
+ | <a id="property-bound"></a> `bound` | `boolean` | `true` if an `on` binding exists for this event name; `false` otherwise. | [packages/play-dom/src/json-render/types.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L120) |
14
+ | <a id="property-emit"></a> `emit` | () => `void` | Fire the bound action, resolving params from the current state store. | [packages/play-dom/src/json-render/types.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L114) |
15
+ | <a id="property-shouldpreventdefault"></a> `shouldPreventDefault` | `boolean` | Whether any binding for this event has `preventDefault: true`. | [packages/play-dom/src/json-render/types.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L118) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MountOptions
4
4
 
5
- Defined in: [packages/play-dom/src/create-play-ui.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/create-play-ui.ts#L35)
5
+ Defined in: [packages/play-dom/src/create-play-ui.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/create-play-ui.ts#L35)
6
6
 
7
7
  Per-mount options that can override factory-level settings.
8
8
 
@@ -10,5 +10,5 @@ Per-mount options that can override factory-level settings.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ---------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, suppresses missing-child warnings during streaming spec ingestion. | [packages/play-dom/src/create-play-ui.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/create-play-ui.ts#L39) |
14
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When omitted, a fresh atom is created per view. | [packages/play-dom/src/create-play-ui.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/create-play-ui.ts#L37) |
13
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, suppresses missing-child warnings during streaming spec ingestion. | [packages/play-dom/src/create-play-ui.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/create-play-ui.ts#L39) |
14
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When omitted, a fresh atom is created per view. | [packages/play-dom/src/create-play-ui.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/create-play-ui.ts#L37) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayDomOptions
4
4
 
5
- Defined in: [packages/play-dom/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/types.ts#L20)
5
+ Defined in: [packages/play-dom/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/types.ts#L20)
6
6
 
7
7
  Options for PlayRenderer.
8
8
 
@@ -10,7 +10,7 @@ Options for PlayRenderer.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------------------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility or advanced use cases. When `registryResult` is provided, this is ignored. If you need actions to receive `setState` and `state`, use `registryResult` instead. | [packages/play-dom/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/types.ts#L38) |
14
- | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to renderSpec so ComponentFn implementations can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings during stream ingestion. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/types.ts#L55) |
15
- | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — provides both the registry and the handlers factory. When provided, `PlayRenderer` wires `setState` and `getState` from the @xstate/store-backed `StateStore` into the handlers factory automatically. This is the preferred approach as it ensures actions always receive live `setState` and `state` bound to the current store. Mutually exclusive with `handlers`. | [packages/play-dom/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/types.ts#L30) |
16
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-dom/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/types.ts#L47) |
13
+ | <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | Pre-resolved handler map — for backward compatibility or advanced use cases. When `registryResult` is provided, this is ignored. If you need actions to receive `setState` and `state`, use `registryResult` instead. | [packages/play-dom/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/types.ts#L38) |
14
+ | <a id="property-loading"></a> `loading?` | `boolean` | When true, indicates the spec is still streaming (e.g. from an AI provider). Forwarded to renderSpec so ComponentFn implementations can read ctx.ctx.loading to show skeleton states. Also suppresses missing-child warnings during stream ingestion. Mirrors the `loading` prop from framework renderer providers. | [packages/play-dom/src/types.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/types.ts#L55) |
15
+ | <a id="property-registryresult"></a> `registryResult?` | [`DefineRegistryResult`](DefineRegistryResult.md) | The result from `defineRegistry` — provides both the registry and the handlers factory. When provided, `PlayRenderer` wires `setState` and `getState` from the @xstate/store-backed `StateStore` into the handlers factory automatically. This is the preferred approach as it ensures actions always receive live `setState` and `state` bound to the current store. Mutually exclusive with `handlers`. | [packages/play-dom/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/types.ts#L30) |
16
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-dom/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/types.ts#L47) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: UIProviderOptions
4
4
 
5
- Defined in: [packages/play-dom/src/json-render/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L63)
5
+ Defined in: [packages/play-dom/src/json-render/types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L63)
6
6
 
7
7
  Shared UI-provider options — the configurable rendering behaviours that sit
8
8
  above the core actor/registry wiring.
@@ -21,7 +21,7 @@ in `types.ts` extend a single source of truth.
21
21
 
22
22
  | Property | Type | Description | Defined in |
23
23
  | ---------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L83) |
25
- | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L77) |
26
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L89) |
27
- | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L68) |
24
+ | <a id="property-functions"></a> `functions?` | `Record`\<`string`, `ComputedFunction`\> | Custom computed functions available to `$computed` field expressions in specs. Mirrors the `functions` prop on `JSONUIProvider` / `JsonUIProvider`. | [packages/play-dom/src/json-render/types.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L83) |
25
+ | <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigation function forwarded to json-render computed functions that need to trigger programmatic navigation (e.g. a `navigate` action in the catalog). | [packages/play-dom/src/json-render/types.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L77) |
26
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Forwarded as `onRenderError` to the underlying renderer. | [packages/play-dom/src/json-render/types.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L89) |
27
+ | <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Custom validation functions for the json-render ValidationProvider equivalent. Each function receives `(value, args?)` and returns a boolean. | [packages/play-dom/src/json-render/types.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L68) |
@@ -6,7 +6,7 @@
6
6
  type ActionFn<C, K> = (params, setState, state) => Promise<void>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L275)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L275)
10
10
 
11
11
  Catalog-typed action function — mirrors `ActionFn<C, K>` from @json-render/react, /solid, /vue.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type Actions<C> = { [K in keyof InferCatalogActions<C>]: ActionFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:285](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L285)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:285](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L285)
10
10
 
11
11
  Map of catalog-typed action handler functions.
12
12
  Each key is a catalog action name; each value is an `ActionFn<C, K>` for that action.
@@ -6,7 +6,7 @@
6
6
  type BaseComponentProps<P> = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L230)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L230)
10
10
 
11
11
  Catalog-agnostic component props type.
12
12
 
@@ -41,7 +41,7 @@ function MyButton({ props, emit }: BaseComponentProps<{ label: string }>) {
41
41
  bindings: Record<string, string> | undefined;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L233)
44
+ Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L233)
45
45
 
46
46
  ---
47
47
 
@@ -51,7 +51,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:233](https://gitlab.com/
51
51
  children: Node[];
52
52
  ```
53
53
 
54
- Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L232)
54
+ Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L232)
55
55
 
56
56
  ---
57
57
 
@@ -61,7 +61,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:232](https://gitlab.com/
61
61
  ctx: DomRenderContext;
62
62
  ```
63
63
 
64
- Defined in: [packages/play-dom/src/json-render/types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L236)
64
+ Defined in: [packages/play-dom/src/json-render/types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L236)
65
65
 
66
66
  ---
67
67
 
@@ -71,7 +71,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:236](https://gitlab.com/
71
71
  emit: (event) => void;
72
72
  ```
73
73
 
74
- Defined in: [packages/play-dom/src/json-render/types.ts:234](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L234)
74
+ Defined in: [packages/play-dom/src/json-render/types.ts:234](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L234)
75
75
 
76
76
  #### Parameters
77
77
 
@@ -91,7 +91,7 @@ Defined in: [packages/play-dom/src/json-render/types.ts:234](https://gitlab.com/
91
91
  on: (event) => EventHandle;
92
92
  ```
93
93
 
94
- Defined in: [packages/play-dom/src/json-render/types.ts:235](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L235)
94
+ Defined in: [packages/play-dom/src/json-render/types.ts:235](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L235)
95
95
 
96
96
  #### Parameters
97
97
 
@@ -111,4 +111,4 @@ Defined in: [packages/play-dom/src/json-render/types.ts:235](https://gitlab.com/
111
111
  props: P;
112
112
  ```
113
113
 
114
- Defined in: [packages/play-dom/src/json-render/types.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L231)
114
+ Defined in: [packages/play-dom/src/json-render/types.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L231)
@@ -10,7 +10,7 @@ type CatalogHasActions<C> = [InferCatalogActions<C>] extends [never]
10
10
  : true;
11
11
  ```
12
12
 
13
- Defined in: [packages/play-dom/src/json-render/types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L101)
13
+ Defined in: [packages/play-dom/src/json-render/types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L101)
14
14
 
15
15
  Evaluates to `true` when a catalog declares at least one action; `false` otherwise.
16
16
 
@@ -6,7 +6,7 @@
6
6
  type ComponentFn<C, K> = (ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L241)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L241)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentRegistry<C> = { [K in keyof InferCatalogComponents<C>]: ComponentFn<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:247](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L247)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:247](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L247)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type DefineRegistryOptions<C> = object & CatalogHasActions<C> extends true ? object : object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L307)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L307)
10
10
 
11
11
  Options for `defineRegistry`.
12
12
 
@@ -18,7 +18,7 @@ fully typed. When the catalog declares actions, `actions` is required; otherwise
18
18
 
19
19
  | Name | Type | Description | Defined in |
20
20
  | ------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
21
- | `components?` | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty. | [packages/play-dom/src/json-render/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L313) |
21
+ | `components?` | [`ComponentRegistry`](ComponentRegistry.md)\<`C`\> | Catalog-typed component implementations. If omitted, all elements fall through to the `fallback` renderer (if provided) or return `null` — the container will be empty. | [packages/play-dom/src/json-render/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L313) |
22
22
 
23
23
  ## Type Parameters
24
24
 
@@ -6,7 +6,7 @@
6
6
  type DomComponentRenderer = (element, ctx) => HTMLElement | Text | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L177)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L177)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -6,4 +6,4 @@
6
6
  type DomRegistry = Record<string, DomComponentRenderer>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:253](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L253)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:253](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L253)
@@ -6,4 +6,4 @@
6
6
  type DomSchema = typeof schema;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/schema.ts#L60)
9
+ Defined in: [packages/play-dom/src/json-render/schema.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/schema.ts#L60)
@@ -6,7 +6,7 @@
6
6
  type MountFn = (actor, container, options?) => () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/create-play-ui.ts#L47)
9
+ Defined in: [packages/play-dom/src/create-play-ui.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/create-play-ui.ts#L47)
10
10
 
11
11
  The mount function returned by createPlayUI.
12
12
  Call with (actor, container, mountOptions?) to start the renderer.
@@ -6,7 +6,7 @@
6
6
  type SetState = (updater) => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/types.ts#L46)
9
+ Defined in: [packages/play-dom/src/json-render/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/types.ts#L46)
10
10
 
11
11
  Function to update the local state store.
12
12
 
@@ -46,7 +46,7 @@ const schema: Schema<{
46
46
  }>;
47
47
  ```
48
48
 
49
- Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom/src/json-render/schema.ts#L20)
49
+ Defined in: [packages/play-dom/src/json-render/schema.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom/src/json-render/schema.ts#L20)
50
50
 
51
51
  The schema for @xmachines/play-dom
52
52
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/connect-router.ts#L48)
9
+ Defined in: [play-dom-router/src/connect-router.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/connect-router.ts#L48)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L120)
9
+ Defined in: [play-dom-router/src/create-browser-history.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L120)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-router/src/create-route-map-from-machine.ts#L26)
9
+ Defined in: [play-router/src/create-route-map-from-machine.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-router/src/create-route-map-from-machine.ts#L26)
10
10
 
11
11
  Create a `RouteMap` from an XState state machine.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-router.ts#L52)
9
+ Defined in: [play-dom-router/src/create-router.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-router.ts#L52)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L1)
5
+ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [play-dom-router/src/create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [play-dom-router/src/create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [play-dom-router/src/create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:1](https://gitlab.com
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L26)
25
+ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:26](https://gitlab.co
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L38)
39
+ Defined in: [play-dom-router/src/create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L47)
61
+ Defined in: [play-dom-router/src/create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L27)
81
+ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [play-dom-router/src/create-browser-history.ts:27](https://gitlab.co
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L25)
95
+ Defined in: [play-dom-router/src/create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L15)
117
+ Defined in: [play-dom-router/src/create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L20)
140
+ Defined in: [play-dom-router/src/create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.36/packages/play-dom-router/src/create-browser-history.ts#L33)
163
+ Defined in: [play-dom-router/src/create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.38/packages/play-dom-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function