@xmachines/docs 1.0.0-beta.29 → 1.0.0-beta.31

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 (292) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  5. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  6. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  8. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  9. package/api/@xmachines/play-dom/README.md +40 -10
  10. package/api/@xmachines/play-dom/classes/PlayRenderer.md +20 -12
  11. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  12. package/api/@xmachines/play-dom/functions/defineRegistry.md +8 -21
  13. package/api/@xmachines/play-dom/functions/renderSpec.md +15 -13
  14. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +9 -48
  15. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  16. package/api/@xmachines/play-dom/interfaces/DefineRegistryOptions.md +7 -9
  17. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +7 -8
  18. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +9 -12
  19. package/api/@xmachines/play-dom/interfaces/EventHandle.md +6 -20
  20. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +5 -5
  21. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +30 -0
  22. package/api/@xmachines/play-dom/type-aliases/Actions.md +18 -0
  23. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -28
  24. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -7
  25. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -17
  26. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -6
  27. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +9 -0
  28. package/api/@xmachines/play-dom/variables/schema.md +56 -0
  29. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  30. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  31. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  32. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  33. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  34. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  35. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  36. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +6 -6
  37. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +3 -3
  38. package/api/@xmachines/play-dom-router/interfaces/RouteMapLike.md +3 -3
  39. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  40. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  41. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  42. package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +1 -1
  43. package/api/@xmachines/play-react/README.md +29 -32
  44. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  45. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  46. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  47. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  48. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  49. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +11 -12
  50. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  51. package/api/@xmachines/play-react/variables/PlayRenderer.md +12 -5
  52. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +23 -23
  53. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  54. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  55. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  56. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  57. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  58. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  60. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  61. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +23 -23
  62. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  63. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  64. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  65. package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +1 -1
  66. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +1 -1
  67. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  68. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  69. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  70. package/api/@xmachines/play-router/functions/extractRouteParams.md +1 -1
  71. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  72. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  73. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  74. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  75. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  76. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  77. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  78. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  79. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  80. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  81. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  82. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  83. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  84. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  85. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  86. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  87. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  88. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  89. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  90. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  91. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  92. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  93. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  94. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  95. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  96. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  97. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  98. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  99. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  100. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  101. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  102. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  103. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  104. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  105. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  106. package/api/@xmachines/play-solid/README.md +28 -29
  107. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  108. package/api/@xmachines/play-solid/functions/useBoundProp.md +45 -0
  109. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +11 -12
  110. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  111. package/api/@xmachines/play-solid/variables/PlayRenderer.md +4 -25
  112. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  113. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +24 -24
  114. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  115. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  116. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  117. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  118. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  119. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  120. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  121. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  122. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  123. package/api/@xmachines/play-svelte/README.md +15 -4
  124. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +8 -9
  125. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +4 -4
  126. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  127. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +4 -4
  129. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +6 -6
  130. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  131. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  132. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  133. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  134. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +4 -4
  135. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  136. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  137. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  138. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  139. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +6 -6
  140. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  141. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  142. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  145. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  146. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  147. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  148. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  149. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  150. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  151. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  152. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  153. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  154. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  155. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  156. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  157. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +24 -24
  158. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  159. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  160. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  161. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  162. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  163. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  164. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  165. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  166. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +3 -3
  167. package/api/@xmachines/play-vue/README.md +33 -33
  168. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  169. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  170. package/api/@xmachines/play-vue/functions/useBoundProp.md +45 -0
  171. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +9 -10
  172. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  173. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  174. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  175. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  176. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  177. package/api/@xmachines/play-vue-router/classes/RouteMap.md +4 -4
  178. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +4 -4
  179. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +24 -24
  180. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  181. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  182. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  183. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  184. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  185. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  186. package/api/@xmachines/play-xstate/README.md +1 -0
  187. package/api/@xmachines/play-xstate/classes/PlayerActor.md +54 -23
  188. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  189. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  190. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  191. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  192. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  193. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  194. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  195. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  196. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  197. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  198. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  199. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  200. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  201. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  202. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  203. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  204. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  205. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  206. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  207. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  208. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  209. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +1 -1
  210. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  211. package/examples/@xmachines/play-dom-demo/README.md +7 -0
  212. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +23 -0
  213. package/examples/@xmachines/play-dom-demo/functions/initShell.md +5 -5
  214. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +9 -0
  215. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  216. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  217. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  218. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  219. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  220. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +9 -0
  221. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  222. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  223. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  224. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  225. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  226. package/examples/@xmachines/{play-actor-shared → play-dom-demo}/variables/authCatalog.md +23 -24
  227. package/examples/@xmachines/play-react-demo/README.md +9 -3
  228. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  229. package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +5 -5
  230. package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +5 -5
  231. package/examples/@xmachines/play-react-demo/functions/Shell.md +7 -7
  232. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +9 -0
  233. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  234. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  235. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  236. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +11 -0
  237. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  238. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  239. package/examples/@xmachines/play-react-demo/variables/NavBar.md +11 -0
  240. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +9 -0
  241. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  242. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  243. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  244. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  245. package/examples/@xmachines/play-react-demo/variables/Shell.md +13 -0
  246. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  247. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +172 -0
  248. package/examples/@xmachines/play-solid-demo/README.md +9 -3
  249. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  250. package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +5 -5
  251. package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +5 -5
  252. package/examples/@xmachines/play-solid-demo/functions/Shell.md +7 -7
  253. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +9 -0
  254. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  255. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  256. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  257. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +11 -0
  258. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  259. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  260. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +11 -0
  261. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +12 -0
  262. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  263. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  264. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  265. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  266. package/examples/@xmachines/play-solid-demo/variables/Shell.md +13 -0
  267. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  268. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +172 -0
  269. package/examples/README.md +0 -8
  270. package/package.json +2 -2
  271. package/api/@xmachines/play-react/functions/useStateBinding.md +0 -34
  272. package/api/@xmachines/play-solid/functions/useStateBinding.md +0 -25
  273. package/api/@xmachines/play-vue/functions/useStateBinding.md +0 -32
  274. package/examples/@xmachines/play-actor-shared/README.md +0 -155
  275. package/examples/@xmachines/play-actor-shared/interfaces/AuthContext.md +0 -14
  276. package/examples/@xmachines/play-actor-shared/type-aliases/AuthActor.md +0 -27
  277. package/examples/@xmachines/play-actor-shared/type-aliases/AuthCatalog.md +0 -16
  278. package/examples/@xmachines/play-actor-shared/type-aliases/AuthEvents.md +0 -17
  279. package/examples/@xmachines/play-actor-shared/type-aliases/AuthInput.md +0 -9
  280. package/examples/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md +0 -11
  281. package/examples/@xmachines/play-actor-shared/type-aliases/CatalogProps.md +0 -187
  282. package/examples/@xmachines/play-actor-shared/type-aliases/InferProps.md +0 -17
  283. package/examples/@xmachines/play-actor-shared/variables/authMachine.md +0 -189
  284. package/examples/@xmachines/play-actor-shared/variables/authSetup.md +0 -22
  285. package/examples/@xmachines/play-router-shared/README.md +0 -111
  286. package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md +0 -3
  287. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md +0 -11
  288. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md +0 -19
  289. package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md +0 -19
  290. package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md +0 -8
  291. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md +0 -63
  292. package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMetaEnv.md +0 -32
@@ -0,0 +1,172 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / authCatalog
2
+
3
+ # Variable: authCatalog
4
+
5
+ ```ts
6
+ const authCatalog: Catalog<
7
+ {
8
+ catalog: SchemaType<
9
+ "object",
10
+ {
11
+ actions: SchemaType<
12
+ "map",
13
+ {
14
+ description: SchemaType<"string", unknown>;
15
+ params: SchemaType<"zod", unknown>;
16
+ }
17
+ >;
18
+ components: SchemaType<
19
+ "map",
20
+ {
21
+ description: SchemaType<"string", unknown>;
22
+ example: SchemaType<"any", unknown>;
23
+ props: SchemaType<"zod", unknown>;
24
+ slots: SchemaType<"array", SchemaType<"string", unknown>>;
25
+ }
26
+ >;
27
+ }
28
+ >;
29
+ spec: SchemaType<
30
+ "object",
31
+ {
32
+ elements: SchemaType<
33
+ "record",
34
+ SchemaType<
35
+ "object",
36
+ {
37
+ children: SchemaType<"array", SchemaType<"string", unknown>>;
38
+ props: SchemaType<"propsOf", string>;
39
+ type: SchemaType<"ref", string>;
40
+ visible: SchemaType<"any", unknown>;
41
+ }
42
+ >
43
+ >;
44
+ root: SchemaType<"string", unknown>;
45
+ }
46
+ >;
47
+ },
48
+ {
49
+ actions: {
50
+ login: {
51
+ description: "Login with username";
52
+ params: ZodObject<
53
+ {
54
+ username: ZodString;
55
+ },
56
+ $strip
57
+ >;
58
+ };
59
+ logout: {
60
+ description: "Logout and return to home";
61
+ };
62
+ route: {
63
+ description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
64
+ params: ZodObject<
65
+ {
66
+ params: ZodOptional<ZodRecord<ZodString, ZodString>>;
67
+ to: ZodString;
68
+ },
69
+ $strip
70
+ >;
71
+ };
72
+ };
73
+ components: {
74
+ About: {
75
+ props: ZodObject<
76
+ {
77
+ title: ZodString;
78
+ },
79
+ $strip
80
+ >;
81
+ };
82
+ Contact: {
83
+ props: ZodObject<
84
+ {
85
+ title: ZodString;
86
+ },
87
+ $strip
88
+ >;
89
+ };
90
+ Dashboard: {
91
+ props: ZodObject<
92
+ {
93
+ username: ZodString;
94
+ welcome: ZodBoolean;
95
+ },
96
+ $strip
97
+ >;
98
+ };
99
+ Home: {
100
+ props: ZodObject<
101
+ {
102
+ title: ZodString;
103
+ },
104
+ $strip
105
+ >;
106
+ };
107
+ Login: {
108
+ props: ZodObject<
109
+ {
110
+ title: ZodString;
111
+ username: ZodOptional<ZodString>;
112
+ },
113
+ $strip
114
+ >;
115
+ };
116
+ NavBar: {
117
+ props: ZodObject<
118
+ {
119
+ isAuthenticated: ZodBoolean;
120
+ username: ZodNullable<ZodString>;
121
+ },
122
+ $strip
123
+ >;
124
+ };
125
+ Navigation: {
126
+ props: ZodObject<
127
+ {
128
+ currentPath: ZodString;
129
+ isAuthenticated: ZodBoolean;
130
+ },
131
+ $strip
132
+ >;
133
+ };
134
+ Overview: {
135
+ props: ZodObject<
136
+ {
137
+ title: ZodString;
138
+ },
139
+ $strip
140
+ >;
141
+ };
142
+ Profile: {
143
+ props: ZodObject<
144
+ {
145
+ username: ZodString;
146
+ },
147
+ $strip
148
+ >;
149
+ };
150
+ Settings: {
151
+ props: ZodObject<
152
+ {
153
+ section: ZodOptional<ZodString>;
154
+ username: ZodString;
155
+ },
156
+ $strip
157
+ >;
158
+ };
159
+ Stats: {
160
+ props: ZodObject<
161
+ {
162
+ title: ZodString;
163
+ },
164
+ $strip
165
+ >;
166
+ };
167
+ };
168
+ }
169
+ >;
170
+ ```
171
+
172
+ Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-react/examples/demo/src/catalog.ts#L5)
@@ -138,22 +138,28 @@ Expected result: library-pattern invariant tests pass and the browser renderer s
138
138
  - [SolidJS package README](../../README.md)
139
139
  - [Solid Router demo README](../../../play-solid-router/examples/demo/README.md)
140
140
 
141
+ ## Type Aliases
142
+
143
+ - [AuthCatalog](type-aliases/AuthCatalog.md)
144
+
141
145
  ## Variables
142
146
 
143
147
  - [About](variables/About.md)
148
+ - [authCatalog](variables/authCatalog.md)
144
149
  - [Contact](variables/Contact.md)
145
150
  - [Dashboard](variables/Dashboard.md)
151
+ - [DebugPanel](variables/DebugPanel.md)
146
152
  - [Home](variables/Home.md)
147
153
  - [Login](variables/Login.md)
154
+ - [NavBar](variables/NavBar.md)
155
+ - [NavBarView](variables/NavBarView.md)
148
156
  - [Navigation](variables/Navigation.md)
149
157
  - [Overview](variables/Overview.md)
150
158
  - [Profile](variables/Profile.md)
151
159
  - [Settings](variables/Settings.md)
160
+ - [Shell](variables/Shell.md)
152
161
  - [Stats](variables/Stats.md)
153
162
 
154
163
  ## Functions
155
164
 
156
165
  - [App](functions/App.md)
157
- - [DebugPanel](functions/DebugPanel.md)
158
- - [HeaderNav](functions/HeaderNav.md)
159
- - [Shell](functions/Shell.md)
@@ -6,7 +6,7 @@
6
6
  function App(): Element;
7
7
  ```
8
8
 
9
- Defined in: [App.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/App.tsx#L55)
9
+ Defined in: [packages/play-solid/examples/demo/src/App.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/App.tsx#L33)
10
10
 
11
11
  ## Returns
12
12
 
@@ -6,14 +6,14 @@
6
6
  function DebugPanel(props): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
9
+ Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
10
10
 
11
11
  ## Parameters
12
12
 
13
- | Parameter | Type |
14
- | ------------- | -------------------------------------------------------------------------------- |
15
- | `props` | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
16
- | `props.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md) |
13
+ | Parameter | Type |
14
+ | ------------- | --------------------------- |
15
+ | `props` | \{ `actor`: `AuthActor`; \} |
16
+ | `props.actor` | `AuthActor` |
17
17
 
18
18
  ## Returns
19
19
 
@@ -6,14 +6,14 @@
6
6
  function HeaderNav(props): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/HeaderNav.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/HeaderNav.tsx#L5)
9
+ Defined in: [components/HeaderNav.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/HeaderNav.tsx#L5)
10
10
 
11
11
  ## Parameters
12
12
 
13
- | Parameter | Type |
14
- | ------------- | -------------------------------------------------------------------------------- |
15
- | `props` | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
16
- | `props.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md) |
13
+ | Parameter | Type |
14
+ | ------------- | --------------------------- |
15
+ | `props` | \{ `actor`: `AuthActor`; \} |
16
+ | `props.actor` | `AuthActor` |
17
17
 
18
18
  ## Returns
19
19
 
@@ -6,16 +6,16 @@
6
6
  function Shell(props): Element;
7
7
  ```
8
8
 
9
- Defined in: [components/Shell.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Shell.tsx#L7)
9
+ Defined in: [components/Shell.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/Shell.tsx#L7)
10
10
 
11
11
  ## Parameters
12
12
 
13
- | Parameter | Type | Description |
14
- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
15
- | `props` | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | - |
16
- | `props.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md) | - |
17
- | `props.registry` | `ComponentRegistry` | - |
18
- | `props.router?` | `unknown` | Bridged router instance — accepted for prop parity with router demos but unused. |
13
+ | Parameter | Type | Description |
14
+ | ---------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
15
+ | `props` | \{ `actor`: `AuthActor`; `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | - |
16
+ | `props.actor` | `AuthActor` | - |
17
+ | `props.registry` | `ComponentRegistry` | - |
18
+ | `props.router?` | `unknown` | Bridged router instance — accepted for prop parity with router demos but unused. |
19
19
 
20
20
  ## Returns
21
21
 
@@ -0,0 +1,9 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / AuthCatalog
2
+
3
+ # Type Alias: AuthCatalog
4
+
5
+ ```ts
6
+ type AuthCatalog = typeof authCatalog;
7
+ ```
8
+
9
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/catalog.ts#L6)
@@ -6,4 +6,4 @@
6
6
  const About: ComponentFn<AuthCatalog, "About">;
7
7
  ```
8
8
 
9
- Defined in: [components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/About.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/About.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/About.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Contact: ComponentFn<AuthCatalog, "Contact">;
7
7
  ```
8
8
 
9
- Defined in: [components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Contact.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Contact.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
7
7
  ```
8
8
 
9
- Defined in: [components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Dashboard.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Dashboard.tsx#L4)
@@ -0,0 +1,11 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / DebugPanel
2
+
3
+ # Variable: DebugPanel
4
+
5
+ ```ts
6
+ const DebugPanel: Component<{
7
+ actor: AuthActor;
8
+ }>;
9
+ ```
10
+
11
+ Defined in: [packages/play-solid/examples/demo/src/components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/DebugPanel.tsx#L5)
@@ -6,4 +6,4 @@
6
6
  const Home: ComponentFn<AuthCatalog, "Home">;
7
7
  ```
8
8
 
9
- Defined in: [components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Home.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Home.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Login: ComponentFn<AuthCatalog, "Login">;
7
7
  ```
8
8
 
9
- Defined in: [components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Login.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Login.tsx#L7)
@@ -0,0 +1,11 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / NavBar
2
+
3
+ # Variable: NavBar
4
+
5
+ ```ts
6
+ const NavBar: Component<{
7
+ actor: AuthActor;
8
+ }>;
9
+ ```
10
+
11
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/NavBar.tsx#L28)
@@ -0,0 +1,12 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / NavBarView
2
+
3
+ # Variable: NavBarView
4
+
5
+ ```ts
6
+ const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
7
+ ```
8
+
9
+ Defined in: [packages/play-solid/examples/demo/src/components/NavBar.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/NavBar.tsx#L20)
10
+
11
+ Catalog-typed NavBar component for use in defineRegistry components map.
12
+ Receives props from spec (isAuthenticated, username) and renders a static nav.
@@ -6,4 +6,4 @@
6
6
  const Navigation: ComponentFn<AuthCatalog, "Navigation">;
7
7
  ```
8
8
 
9
- Defined in: [components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Navigation.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Navigation.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Overview: ComponentFn<AuthCatalog, "Overview">;
7
7
  ```
8
8
 
9
- Defined in: [components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Overview.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Overview.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Profile: ComponentFn<AuthCatalog, "Profile">;
7
7
  ```
8
8
 
9
- Defined in: [components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Profile.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Profile.tsx#L4)
@@ -6,4 +6,4 @@
6
6
  const Settings: ComponentFn<AuthCatalog, "Settings">;
7
7
  ```
8
8
 
9
- Defined in: [components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Settings.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Settings.tsx#L4)
@@ -0,0 +1,13 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / Shell
2
+
3
+ # Variable: Shell
4
+
5
+ ```ts
6
+ const Shell: Component<{
7
+ actor: AuthActor;
8
+ registryResult: DefineRegistryResult;
9
+ router?: unknown;
10
+ }>;
11
+ ```
12
+
13
+ Defined in: [packages/play-solid/examples/demo/src/components/Shell.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Shell.tsx#L8)
@@ -6,4 +6,4 @@
6
6
  const Stats: ComponentFn<AuthCatalog, "Stats">;
7
7
  ```
8
8
 
9
- Defined in: [components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
9
+ Defined in: [packages/play-solid/examples/demo/src/components/Stats.tsx:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/components/Stats.tsx#L4)
@@ -0,0 +1,172 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / authCatalog
2
+
3
+ # Variable: authCatalog
4
+
5
+ ```ts
6
+ const authCatalog: Catalog<
7
+ {
8
+ catalog: SchemaType<
9
+ "object",
10
+ {
11
+ actions: SchemaType<
12
+ "map",
13
+ {
14
+ description: SchemaType<"string", unknown>;
15
+ params: SchemaType<"zod", unknown>;
16
+ }
17
+ >;
18
+ components: SchemaType<
19
+ "map",
20
+ {
21
+ description: SchemaType<"string", unknown>;
22
+ example: SchemaType<"any", unknown>;
23
+ props: SchemaType<"zod", unknown>;
24
+ slots: SchemaType<"array", SchemaType<"string", unknown>>;
25
+ }
26
+ >;
27
+ }
28
+ >;
29
+ spec: SchemaType<
30
+ "object",
31
+ {
32
+ elements: SchemaType<
33
+ "record",
34
+ SchemaType<
35
+ "object",
36
+ {
37
+ children: SchemaType<"array", SchemaType<"string", unknown>>;
38
+ props: SchemaType<"propsOf", string>;
39
+ type: SchemaType<"ref", string>;
40
+ visible: SchemaType<"any", unknown>;
41
+ }
42
+ >
43
+ >;
44
+ root: SchemaType<"string", unknown>;
45
+ }
46
+ >;
47
+ },
48
+ {
49
+ actions: {
50
+ login: {
51
+ description: "Login with username";
52
+ params: ZodObject<
53
+ {
54
+ username: ZodString;
55
+ },
56
+ $strip
57
+ >;
58
+ };
59
+ logout: {
60
+ description: "Logout and return to home";
61
+ };
62
+ route: {
63
+ description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
64
+ params: ZodObject<
65
+ {
66
+ params: ZodOptional<ZodRecord<ZodString, ZodString>>;
67
+ to: ZodString;
68
+ },
69
+ $strip
70
+ >;
71
+ };
72
+ };
73
+ components: {
74
+ About: {
75
+ props: ZodObject<
76
+ {
77
+ title: ZodString;
78
+ },
79
+ $strip
80
+ >;
81
+ };
82
+ Contact: {
83
+ props: ZodObject<
84
+ {
85
+ title: ZodString;
86
+ },
87
+ $strip
88
+ >;
89
+ };
90
+ Dashboard: {
91
+ props: ZodObject<
92
+ {
93
+ username: ZodString;
94
+ welcome: ZodBoolean;
95
+ },
96
+ $strip
97
+ >;
98
+ };
99
+ Home: {
100
+ props: ZodObject<
101
+ {
102
+ title: ZodString;
103
+ },
104
+ $strip
105
+ >;
106
+ };
107
+ Login: {
108
+ props: ZodObject<
109
+ {
110
+ title: ZodString;
111
+ username: ZodOptional<ZodString>;
112
+ },
113
+ $strip
114
+ >;
115
+ };
116
+ NavBar: {
117
+ props: ZodObject<
118
+ {
119
+ isAuthenticated: ZodBoolean;
120
+ username: ZodNullable<ZodString>;
121
+ },
122
+ $strip
123
+ >;
124
+ };
125
+ Navigation: {
126
+ props: ZodObject<
127
+ {
128
+ currentPath: ZodString;
129
+ isAuthenticated: ZodBoolean;
130
+ },
131
+ $strip
132
+ >;
133
+ };
134
+ Overview: {
135
+ props: ZodObject<
136
+ {
137
+ title: ZodString;
138
+ },
139
+ $strip
140
+ >;
141
+ };
142
+ Profile: {
143
+ props: ZodObject<
144
+ {
145
+ username: ZodString;
146
+ },
147
+ $strip
148
+ >;
149
+ };
150
+ Settings: {
151
+ props: ZodObject<
152
+ {
153
+ section: ZodOptional<ZodString>;
154
+ username: ZodString;
155
+ },
156
+ $strip
157
+ >;
158
+ };
159
+ Stats: {
160
+ props: ZodObject<
161
+ {
162
+ title: ZodString;
163
+ },
164
+ $strip
165
+ >;
166
+ };
167
+ };
168
+ }
169
+ >;
170
+ ```
171
+
172
+ Defined in: [packages/play-solid/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.31/packages/play-solid/examples/demo/src/catalog.ts#L5)
@@ -50,14 +50,6 @@ Complete working implementations of actor-authoritative routing with all archite
50
50
  - [@xmachines/play-vue-router-demo](@xmachines/play-vue-router-demo/README.md)
51
51
  <!-- typedoc:router-demos:end -->
52
52
 
53
- ### Shared Fixtures
54
-
55
- <!-- typedoc:shared-fixtures:start -->
56
-
57
- - [@xmachines/play-actor-shared](@xmachines/play-actor-shared/README.md)
58
- - [@xmachines/play-router-shared](@xmachines/play-router-shared/README.md)
59
- <!-- typedoc:shared-fixtures:end -->
60
-
61
53
  ## Running the Code Examples
62
54
 
63
55
  The conceptual examples in this directory are TypeScript snippets. To run them:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xmachines/docs",
3
- "version": "1.0.0-beta.29",
3
+ "version": "1.0.0-beta.31",
4
4
  "description": "Documentation for XMachines",
5
5
  "keywords": [
6
6
  "documentation",
@@ -49,7 +49,7 @@
49
49
  "test": "vitest run"
50
50
  },
51
51
  "devDependencies": {
52
- "@xmachines/shared": "1.0.0-beta.29",
52
+ "@xmachines/shared": "1.0.0-beta.31",
53
53
  "oxfmt": "^0.43.0",
54
54
  "oxlint": "^1.57.0",
55
55
  "typedoc": "^0.28.18",
@@ -1,34 +0,0 @@
1
- [Documentation](../../../README.md) / [@xmachines/play-react](../README.md) / useStateBinding
2
-
3
- # ~~Function: useStateBinding()~~
4
-
5
- ```ts
6
- function useStateBinding<T>(path): [T | undefined, (value) => void];
7
- ```
8
-
9
- Defined in: `@json-render/react`
10
-
11
- Hook to get and set a value from the state model (like useState).
12
-
13
- ## Type Parameters
14
-
15
- | Type Parameter |
16
- | -------------- |
17
- | `T` |
18
-
19
- ## Parameters
20
-
21
- | Parameter | Type |
22
- | --------- | -------- |
23
- | `path` | `string` |
24
-
25
- ## Returns
26
-
27
- \[`T` \| `undefined`, (`value`) => `void`\]
28
-
29
- ## Deprecated
30
-
31
- Use [useBoundProp](useBoundProp.md) with `$bindState` expressions instead.
32
- `useStateBinding` takes a raw state path string, while `useBoundProp` works
33
- with the renderer's `bindings` map and supports both `$bindState` and
34
- `$bindItem` expressions.