@xmachines/docs 1.0.0-beta.9 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +135 -7
- package/api/@xmachines/play/README.md +159 -39
- package/api/@xmachines/play/classes/NonNullableError.md +189 -0
- package/api/@xmachines/play/classes/PlayError.md +251 -0
- package/api/@xmachines/play/functions/assertNonNullable.md +56 -0
- package/api/@xmachines/play/type-aliases/PlayEvent.md +6 -6
- package/api/@xmachines/play-actor/README.md +153 -160
- package/api/@xmachines/play-actor/classes/AbstractActor.md +106 -121
- package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
- package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
- package/api/@xmachines/play-actor/functions/typedSpec.md +54 -0
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +46 -0
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +33 -0
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +28 -0
- package/api/@xmachines/play-actor/interfaces/Routable.md +6 -21
- package/api/@xmachines/play-actor/interfaces/Viewable.md +12 -6
- package/api/@xmachines/play-dom/README.md +385 -0
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +115 -0
- package/api/@xmachines/play-dom/functions/createPlayUI.md +28 -0
- package/api/@xmachines/play-dom/functions/createRenderer.md +44 -0
- package/api/@xmachines/play-dom/functions/defineRegistry.md +26 -0
- package/api/@xmachines/play-dom/functions/renderSpec.md +67 -0
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +23 -0
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +34 -0
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +17 -0
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +28 -0
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +15 -0
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +18 -0
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +30 -0
- package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +26 -0
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +32 -0
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +46 -0
- package/api/@xmachines/play-dom/type-aliases/Actions.md +18 -0
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +114 -0
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +25 -0
- package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +26 -0
- package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +15 -0
- package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +39 -0
- package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +20 -0
- package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +9 -0
- package/api/@xmachines/play-dom/type-aliases/DomSchema.md +9 -0
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +27 -0
- package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +23 -0
- package/api/@xmachines/play-dom/type-aliases/SetState.md +30 -0
- package/api/@xmachines/play-dom/variables/schema.md +62 -0
- package/api/@xmachines/play-dom-router/README.md +272 -0
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +43 -0
- package/api/@xmachines/{play-router → play-dom-router}/functions/createBrowserHistory.md +10 -2
- package/api/@xmachines/play-dom-router/functions/createRouteMap.md +39 -0
- package/api/@xmachines/play-dom-router/functions/createRouter.md +54 -0
- package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +176 -0
- package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +69 -0
- package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +15 -0
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +129 -0
- package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +68 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +54 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +121 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +27 -0
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +104 -0
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +28 -0
- package/api/@xmachines/play-react/README.md +185 -333
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +46 -42
- package/api/@xmachines/play-react/functions/ActionProvider.md +21 -0
- package/api/@xmachines/play-react/functions/JSONUIProvider.md +21 -0
- package/api/@xmachines/play-react/functions/Renderer.md +21 -0
- package/api/@xmachines/play-react/functions/StateProvider.md +27 -0
- package/api/@xmachines/play-react/functions/ValidationProvider.md +21 -0
- package/api/@xmachines/play-react/functions/VisibilityProvider.md +21 -0
- package/api/@xmachines/play-react/functions/defineRegistry.md +49 -0
- package/api/@xmachines/play-react/functions/useActor.md +13 -0
- package/api/@xmachines/play-react/functions/useBoundProp.md +45 -0
- package/api/@xmachines/play-react/functions/usePlayView.md +32 -0
- package/api/@xmachines/play-react/functions/useSignalEffect.md +29 -20
- package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +15 -0
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +27 -0
- package/api/@xmachines/play-react/interfaces/ComponentContext.md +37 -0
- package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +22 -0
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +7 -7
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +26 -0
- package/api/@xmachines/play-react/interfaces/RendererProps.md +17 -0
- package/api/@xmachines/play-react/interfaces/StateProviderProps.md +16 -0
- package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +14 -0
- package/api/@xmachines/play-react/interfaces/ViewContextValue.md +20 -0
- package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +13 -0
- package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +11 -0
- package/api/@xmachines/play-react/type-aliases/ComponentFn.md +36 -0
- package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +23 -0
- package/api/@xmachines/play-react/variables/ActorProvider.md +33 -0
- package/api/@xmachines/play-react/variables/PlayRenderer.md +6 -56
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +43 -0
- package/api/@xmachines/play-react-router/README.md +130 -115
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +19 -242
- package/api/@xmachines/play-react-router/classes/RouteMap.md +48 -36
- package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +39 -0
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +23 -12
- package/api/@xmachines/play-react-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +25 -9
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +19 -9
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +32 -0
- package/api/@xmachines/play-router/README.md +275 -352
- package/api/@xmachines/play-router/classes/RouteMap.md +149 -0
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -221
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +32 -0
- package/api/@xmachines/play-router/functions/buildRouteTree.md +12 -2
- package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +46 -0
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +14 -7
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +10 -46
- package/api/@xmachines/play-router/functions/extractQuery.md +22 -0
- package/api/@xmachines/play-router/functions/extractRouteParams.md +54 -0
- package/api/@xmachines/play-router/functions/findRouteById.md +2 -2
- package/api/@xmachines/play-router/functions/findRouteByPath.md +2 -2
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +43 -0
- package/api/@xmachines/play-router/functions/isRouteReachable.md +38 -0
- package/api/@xmachines/play-router/functions/machineToGraph.md +19 -0
- package/api/@xmachines/play-router/functions/routeExists.md +2 -2
- package/api/@xmachines/play-router/functions/sanitizePathname.md +40 -0
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +10 -9
- package/api/@xmachines/play-router/functions/validateStateExists.md +9 -9
- package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +13 -0
- package/api/@xmachines/play-router/interfaces/LocationLike.md +27 -0
- package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +15 -0
- package/api/@xmachines/play-router/interfaces/MachineNodeData.md +17 -0
- package/api/@xmachines/play-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-router/interfaces/ResolvedRoutePath.md +17 -0
- package/api/@xmachines/play-router/interfaces/RoutableActor.md +64 -0
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +11 -11
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-router/interfaces/RouteMapping.md +27 -0
- package/api/@xmachines/play-router/interfaces/RouteMatch.md +12 -0
- package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
- package/api/@xmachines/play-router/interfaces/RouteObject.md +5 -5
- package/api/@xmachines/play-router/interfaces/RouteTree.md +8 -7
- package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +55 -0
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-router/interfaces/WindowLike.md +65 -0
- package/api/@xmachines/play-router/type-aliases/MachineGraph.md +20 -0
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
- package/api/@xmachines/play-signals/README.md +117 -65
- package/api/@xmachines/play-signals/functions/watchSignal.md +42 -0
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +7 -5
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +7 -5
- package/api/@xmachines/play-signals/interfaces/SignalState.md +4 -4
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +5 -5
- package/api/@xmachines/play-signals/namespaces/Signal/README.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +7 -7
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +8 -8
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +7 -7
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/README.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +9 -9
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +2 -2
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +2 -2
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
- package/api/@xmachines/play-solid/README.md +196 -233
- package/api/@xmachines/play-solid/functions/ActionProvider.md +19 -0
- package/api/@xmachines/play-solid/functions/JSONUIProvider.md +21 -0
- package/api/@xmachines/play-solid/functions/Renderer.md +21 -0
- package/api/@xmachines/play-solid/functions/StateProvider.md +19 -0
- package/api/@xmachines/play-solid/functions/ValidationProvider.md +19 -0
- package/api/@xmachines/play-solid/functions/VisibilityProvider.md +20 -0
- package/api/@xmachines/play-solid/functions/defineRegistry.md +49 -0
- package/api/@xmachines/play-solid/functions/useAction.md +24 -0
- package/api/@xmachines/play-solid/functions/useActions.md +13 -0
- package/api/@xmachines/play-solid/functions/useActor.md +13 -0
- package/api/@xmachines/play-solid/functions/useBoundProp.md +45 -0
- package/api/@xmachines/play-solid/functions/useFieldValidation.md +29 -0
- package/api/@xmachines/play-solid/functions/useIsVisible.md +19 -0
- package/api/@xmachines/play-solid/functions/useOptionalValidation.md +13 -0
- package/api/@xmachines/play-solid/functions/usePlayView.md +30 -0
- package/api/@xmachines/play-solid/functions/useStateBinding.md +25 -0
- package/api/@xmachines/play-solid/functions/useStateStore.md +13 -0
- package/api/@xmachines/play-solid/functions/useStateValue.md +25 -0
- package/api/@xmachines/play-solid/functions/useVisibility.md +13 -0
- package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +12 -0
- package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +30 -0
- package/api/@xmachines/play-solid/interfaces/ComponentContext.md +37 -0
- package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +15 -0
- package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +22 -0
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +26 -0
- package/api/@xmachines/play-solid/interfaces/RendererProps.md +17 -0
- package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +13 -0
- package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +11 -0
- package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +21 -0
- package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +11 -0
- package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +36 -0
- package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +11 -0
- package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +23 -0
- package/api/@xmachines/play-solid/type-aliases/SetState.md +21 -0
- package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +9 -0
- package/api/@xmachines/play-solid/variables/ActorContext.md +13 -0
- package/api/@xmachines/play-solid/variables/ActorProvider.md +27 -0
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +6 -62
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +26 -0
- package/api/@xmachines/play-solid-router/README.md +151 -559
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +31 -32
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +27 -242
- package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +18 -11
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +99 -114
- package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +25 -9
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +20 -7
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +8 -4
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +22 -19
- package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +52 -0
- package/api/@xmachines/play-svelte/README.md +270 -0
- package/api/@xmachines/play-svelte/functions/defineRegistry.md +31 -0
- package/api/@xmachines/play-svelte/functions/getActorContext.md +21 -0
- package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +19 -0
- package/api/@xmachines/play-svelte/functions/setActorContext.md +19 -0
- package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +44 -0
- package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +29 -0
- package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +29 -0
- package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +24 -0
- package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
- package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +24 -0
- package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +30 -0
- package/api/@xmachines/play-svelte/type-aliases/Actions.md +17 -0
- package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +11 -0
- package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +18 -0
- package/api/@xmachines/play-svelte/type-aliases/JSONUIProviderProps.md +7 -0
- package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +9 -0
- package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +23 -0
- package/api/@xmachines/play-svelte/type-aliases/SetState.md +21 -0
- package/api/@xmachines/play-svelte/variables/PlayRenderer.md +9 -0
- package/api/@xmachines/play-svelte-spa-router/README.md +197 -0
- package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +149 -0
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +32 -0
- package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +39 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +17 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +129 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +27 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +104 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +65 -0
- package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +9 -0
- package/api/@xmachines/play-sveltekit-router/README.md +212 -0
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +149 -0
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +32 -0
- package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +39 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +13 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +27 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +129 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +27 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +104 -0
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +9 -0
- package/api/@xmachines/play-tanstack-react-router/README.md +155 -125
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +48 -36
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +31 -252
- package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +22 -36
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +23 -12
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +28 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +25 -9
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +19 -9
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +40 -18
- package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +34 -0
- package/api/@xmachines/play-tanstack-router/README.md +61 -0
- package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +131 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
- package/api/@xmachines/play-tanstack-solid-router/README.md +216 -175
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +31 -32
- package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +121 -0
- package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +18 -11
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +23 -9
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +14 -10
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +8 -4
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +40 -18
- package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
- package/api/@xmachines/play-vue/README.md +190 -210
- package/api/@xmachines/play-vue/functions/defineRegistry.md +32 -0
- package/api/@xmachines/play-vue/functions/getPlayViewContext.md +28 -0
- package/api/@xmachines/play-vue/functions/useActor.md +13 -0
- package/api/@xmachines/play-vue/functions/useBoundProp.md +45 -0
- package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +12 -0
- package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +25 -0
- package/api/@xmachines/play-vue/interfaces/ComponentContext.md +37 -0
- package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +15 -0
- package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +21 -0
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +24 -0
- package/api/@xmachines/play-vue/interfaces/RendererProps.md +17 -0
- package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +15 -0
- package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +11 -0
- package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +21 -0
- package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
- package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +11 -0
- package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +16 -0
- package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +35 -0
- package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +15 -0
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +22 -0
- package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +23 -0
- package/api/@xmachines/play-vue/variables/ActionProvider.md +64 -0
- package/api/@xmachines/play-vue/variables/JSONUIProvider.md +105 -0
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-vue/variables/Renderer.md +88 -0
- package/api/@xmachines/play-vue/variables/StateProvider.md +79 -0
- package/api/@xmachines/play-vue/variables/ValidationProvider.md +55 -0
- package/api/@xmachines/play-vue/variables/VisibilityProvider.md +40 -0
- package/api/@xmachines/play-vue-router/README.md +173 -486
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +56 -116
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +23 -271
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
- package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +68 -0
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +22 -12
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +20 -8
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +8 -8
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +8 -4
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +12 -6
- package/api/@xmachines/play-xstate/README.md +203 -354
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +195 -201
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +24 -20
- package/api/@xmachines/play-xstate/functions/composeGuards.md +8 -3
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +8 -3
- package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +43 -0
- package/api/@xmachines/play-xstate/functions/definePlayer.md +14 -63
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
- package/api/@xmachines/play-xstate/functions/eventMatches.md +8 -3
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +3 -3
- package/api/@xmachines/play-xstate/functions/hasContext.md +8 -5
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
- package/api/@xmachines/play-xstate/functions/negateGuard.md +8 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +10 -14
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +22 -0
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +14 -16
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +15 -13
- package/api/@xmachines/play-xstate/interfaces/RouteObject.md +17 -0
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +8 -3
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +8 -6
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +9 -7
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +15 -18
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +15 -5
- package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +9 -0
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +22 -6
- package/api/@xmachines/shared/README.md +95 -295
- package/api/@xmachines/shared/vite-aliases/README.md +11 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +38 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +27 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +35 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +42 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
- package/api/@xmachines/shared/vitest/README.md +12 -0
- package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +34 -0
- package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
- package/api/README.md +6 -7
- package/api/llms.txt +72 -23
- package/contributing/README.md +10 -0
- package/contributing/architecture.md +601 -0
- package/contributing/configuration.md +368 -0
- package/contributing/deployment.md +333 -0
- package/contributing/development.md +503 -0
- package/contributing/testing.md +461 -0
- package/examples/@xmachines/play-dom-demo/README.md +181 -0
- package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +24 -0
- package/examples/@xmachines/play-dom-demo/functions/initShell.md +25 -0
- package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +9 -0
- package/examples/@xmachines/play-dom-demo/variables/About.md +12 -0
- package/examples/@xmachines/play-dom-demo/variables/Contact.md +12 -0
- package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Home.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Login.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +16 -0
- package/examples/@xmachines/play-dom-demo/variables/Navigation.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Overview.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Profile.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Settings.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/Stats.md +13 -0
- package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +172 -0
- package/examples/@xmachines/play-dom-router-demo/README.md +145 -0
- package/examples/@xmachines/play-react-demo/README.md +187 -0
- package/examples/@xmachines/play-react-demo/functions/App.md +13 -0
- package/examples/@xmachines/play-react-demo/functions/DebugPanel.md +20 -0
- package/examples/@xmachines/play-react-demo/functions/HeaderNav.md +20 -0
- package/examples/@xmachines/play-react-demo/functions/Shell.md +22 -0
- package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +9 -0
- package/examples/@xmachines/play-react-demo/variables/About.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Contact.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Dashboard.md +15 -0
- package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +16 -0
- package/examples/@xmachines/play-react-demo/variables/Home.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Login.md +16 -0
- package/examples/@xmachines/play-react-demo/variables/NavBar.md +16 -0
- package/examples/@xmachines/play-react-demo/variables/NavBarView.md +15 -0
- package/examples/@xmachines/play-react-demo/variables/Navigation.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Overview.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Profile.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Settings.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/Shell.md +19 -0
- package/examples/@xmachines/play-react-demo/variables/Stats.md +14 -0
- package/examples/@xmachines/play-react-demo/variables/authCatalog.md +172 -0
- package/examples/@xmachines/play-react-router-demo/README.md +151 -0
- package/examples/@xmachines/play-solid-demo/README.md +187 -0
- package/examples/@xmachines/play-solid-demo/functions/App.md +13 -0
- package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md +20 -0
- package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md +20 -0
- package/examples/@xmachines/play-solid-demo/functions/Shell.md +22 -0
- package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/About.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Contact.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +17 -0
- package/examples/@xmachines/play-solid-demo/variables/Home.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Login.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/NavBar.md +11 -0
- package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +15 -0
- package/examples/@xmachines/play-solid-demo/variables/Navigation.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Overview.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Profile.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Settings.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/Shell.md +18 -0
- package/examples/@xmachines/play-solid-demo/variables/Stats.md +9 -0
- package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +172 -0
- package/examples/@xmachines/play-solid-router-demo/README.md +137 -0
- package/examples/@xmachines/play-svelte-demo/README.md +143 -0
- package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +9 -0
- package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +9 -0
- package/examples/@xmachines/play-svelte-demo/variables/App.md +9 -0
- package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +172 -0
- package/examples/@xmachines/play-svelte-spa-router-demo/README.md +129 -0
- package/examples/@xmachines/play-sveltekit-router-demo/README.md +133 -0
- package/examples/@xmachines/play-tanstack-react-router-demo/README.md +156 -0
- package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +139 -0
- package/examples/@xmachines/play-vue-demo/README.md +183 -0
- package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +9 -0
- package/examples/@xmachines/play-vue-demo/variables/App.md +9 -0
- package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +172 -0
- package/examples/@xmachines/play-vue-router-demo/README.md +139 -0
- package/examples/README.md +78 -30
- package/examples/basic-state-machine.md +73 -31
- package/examples/form-validation.md +259 -118
- package/examples/multi-router-integration.md +312 -194
- package/examples/routing-patterns.md +228 -189
- package/examples/traffic-light.md +112 -65
- package/guides/README.md +7 -21
- package/guides/actor-model.md +180 -0
- package/guides/getting-started.md +627 -137
- package/guides/signals.md +166 -0
- package/guides/state-machines.md +284 -0
- package/package.json +21 -7
- package/rfc/broker.md +100 -0
- package/rfc/browser.md +44 -0
- package/rfc/cli.md +118 -0
- package/rfc/git.md +61 -0
- package/rfc/mcp.md +43 -0
- package/rfc/node.md +36 -0
- package/rfc/play.md +472 -0
- package/rfc/rest.md +102 -0
- package/rfc/run.md +159 -0
- package/rfc/streams.md +168 -0
- package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +0 -17
- package/api/@xmachines/play-catalog/README.md +0 -331
- package/api/@xmachines/play-catalog/functions/defineCatalog.md +0 -98
- package/api/@xmachines/play-catalog/functions/defineComponents.md +0 -134
- package/api/@xmachines/play-catalog/type-aliases/Catalog.md +0 -48
- package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +0 -20
- package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +0 -65
- package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +0 -17
- package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +0 -15
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +0 -19
- package/api/@xmachines/play-react-router-demo/README.md +0 -137
- package/api/@xmachines/play-router/classes/BaseRouteMap.md +0 -142
- package/api/@xmachines/play-router/functions/connectRouter.md +0 -67
- package/api/@xmachines/play-router/functions/crawlMachine.md +0 -92
- package/api/@xmachines/play-router/functions/createRouter.md +0 -76
- package/api/@xmachines/play-router/functions/extractRoute.md +0 -45
- package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +0 -27
- package/api/@xmachines/play-router/interfaces/BrowserHistory.md +0 -172
- package/api/@xmachines/play-router/interfaces/BrowserWindow.md +0 -69
- package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +0 -13
- package/api/@xmachines/play-router/interfaces/RouteMap.md +0 -56
- package/api/@xmachines/play-router/interfaces/StateVisit.md +0 -15
- package/api/@xmachines/play-router/interfaces/VanillaRouter.md +0 -28
- package/api/@xmachines/play-router-demo/README.md +0 -137
- package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +0 -15
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +0 -19
- package/api/@xmachines/play-solid-router-demo/README.md +0 -127
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +0 -19
- package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +0 -38
- package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +0 -33
- package/api/@xmachines/play-tanstack-react-router/variables/extractMachineRoutes.md +0 -64
- package/api/@xmachines/play-tanstack-react-router-demo/README.md +0 -126
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +0 -343
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -19
- package/api/@xmachines/play-tanstack-solid-router-demo/README.md +0 -126
- package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +0 -14
- package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +0 -201
- package/api/@xmachines/play-vue-router-demo/README.md +0 -133
- package/api/@xmachines/play-xstate/functions/mergeViewProps.md +0 -26
- package/api/@xmachines/play-xstate/functions/stateMatches.md +0 -25
- package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +0 -39
- package/api/@xmachines/play-xstate/functions/validateViewProps.md +0 -80
- package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +0 -16
- package/api/@xmachines/play-xstate/type-aliases/Catalog.md +0 -21
- package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +0 -17
- package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +0 -35
- package/api/@xmachines/shared/functions/defineXmVitestConfig.md +0 -29
- package/api/@xmachines/shared/functions/xmAliases.md +0 -24
- package/guides/installation.md +0 -323
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / TanStackRouterInstance
|
|
2
2
|
|
|
3
3
|
# Type Alias: TanStackRouterInstance
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
|
-
type TanStackRouterInstance = ConstructorParameters<typeof
|
|
6
|
+
type TanStackRouterInstance = ConstructorParameters<typeof TanStackSolidRouterBridge>[0];
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L22)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / TanStackRouterLike
|
|
2
2
|
|
|
3
3
|
# Type Alias: TanStackRouterLike
|
|
4
4
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
type TanStackRouterLike = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-tanstack-
|
|
9
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
|
|
10
|
+
|
|
11
|
+
Structural (type-only) interface for the TanStack Router surface used by
|
|
12
|
+
`TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
|
|
13
|
+
`@tanstack/solid-router` instances satisfy it.
|
|
10
14
|
|
|
11
15
|
## Properties
|
|
12
16
|
|
|
@@ -16,7 +20,29 @@ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://g
|
|
|
16
20
|
history: object;
|
|
17
21
|
```
|
|
18
22
|
|
|
19
|
-
Defined in: [play-tanstack-
|
|
23
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
|
|
24
|
+
|
|
25
|
+
#### location
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
location: object;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Current location — populated from `window.location` when `createRouter()` runs,
|
|
32
|
+
before `router.load()`. Always available in the browser.
|
|
33
|
+
`router.state.location` is only populated after `router.load()` and may be stale.
|
|
34
|
+
|
|
35
|
+
##### location.pathname
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
pathname: string;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
##### location.search?
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
optional search?: string;
|
|
45
|
+
```
|
|
20
46
|
|
|
21
47
|
#### subscribe()
|
|
22
48
|
|
|
@@ -34,29 +60,25 @@ subscribe(handler): () => void;
|
|
|
34
60
|
|
|
35
61
|
() => `void`
|
|
36
62
|
|
|
37
|
-
|
|
63
|
+
## Methods
|
|
38
64
|
|
|
39
|
-
###
|
|
65
|
+
### load()?
|
|
40
66
|
|
|
41
67
|
```ts
|
|
42
|
-
optional
|
|
68
|
+
optional load(): void | Promise<void>;
|
|
43
69
|
```
|
|
44
70
|
|
|
45
|
-
Defined in: [play-tanstack-
|
|
46
|
-
|
|
47
|
-
#### location?
|
|
71
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
|
|
48
72
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
73
|
+
Re-runs TanStack route matching and loaders for the current location.
|
|
74
|
+
Optional: the bridge calls it (fire-and-forget) after every navigation so
|
|
75
|
+
matching/loaders stay in sync even without a mounted `<RouterProvider>`.
|
|
52
76
|
|
|
53
|
-
|
|
77
|
+
#### Returns
|
|
54
78
|
|
|
55
|
-
|
|
56
|
-
optional pathname?: string;
|
|
57
|
-
```
|
|
79
|
+
`void` \| `Promise`\<`void`\>
|
|
58
80
|
|
|
59
|
-
|
|
81
|
+
---
|
|
60
82
|
|
|
61
83
|
### navigate()
|
|
62
84
|
|
|
@@ -64,7 +86,7 @@ optional pathname?: string;
|
|
|
64
86
|
navigate(args): void;
|
|
65
87
|
```
|
|
66
88
|
|
|
67
|
-
Defined in: [play-tanstack-
|
|
89
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
|
|
68
90
|
|
|
69
91
|
#### Parameters
|
|
70
92
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / PlayRouterProvider
|
|
2
|
+
|
|
3
|
+
# Variable: PlayRouterProvider
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
const PlayRouterProvider: <TActor>(props) => any;
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L42)
|
|
10
|
+
|
|
11
|
+
Connects a `PlayerActor` to TanStack Solid Router, keeping actor state and
|
|
12
|
+
browser URL in sync bidirectionally.
|
|
13
|
+
|
|
14
|
+
The bridge is created once per component instance at component evaluation time
|
|
15
|
+
and torn down via `onCleanup` when the component is disposed. Unlike React,
|
|
16
|
+
prop stability is not a concern — Solid's `props` accessor is already reactive
|
|
17
|
+
and the bridge is created once per component instance.
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
| Type Parameter |
|
|
22
|
+
| ------------------------------------------------------------ |
|
|
23
|
+
| `TActor` _extends_ [`PlayActor`](../interfaces/PlayActor.md) |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type |
|
|
28
|
+
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| `props` | [`PlayRouterProviderBaseProps`](../interfaces/PlayRouterProviderBaseProps.md)\<[`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md), `TActor`\> |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`any`
|
|
@@ -1,292 +1,272 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../README.md) / @xmachines/play-vue
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# `@xmachines/play-vue`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
> Vue 3 renderer for the XMachines Play Architecture — passively observes actor signals and renders UI via `@xmachines/json-render-vue`.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Part of the [XMachines Play monorepo](../../README.md).
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
[](https://opensource.org/licenses/MIT)
|
|
10
|
+
[](https://www.npmjs.com/package/@xmachines/play-vue)
|
|
11
|
+
|
|
12
|
+
---
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
## Overview
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
`@xmachines/play-vue` is the Vue 3 rendering layer for XMachines Play. It bridges TC39 Signals (actor state) to Vue reactivity and drives component rendering through `@xmachines/json-render-vue`.
|
|
14
17
|
|
|
15
|
-
|
|
16
|
-
- **Passive Infrastructure (INV-04):** Components observe signals, send events to actor
|
|
18
|
+
**Architecture invariants this package upholds:**
|
|
17
19
|
|
|
18
|
-
**
|
|
20
|
+
- **Passive Infrastructure** — Components observe actor signals; they never decide state transitions.
|
|
21
|
+
- **Signal-Only Reactivity** — TC39 Signals are the source of truth; Vue reactivity is used only to trigger re-renders.
|
|
22
|
+
- **Actor Authority** — The actor controls view selection; the renderer reflects it.
|
|
19
23
|
|
|
20
|
-
|
|
24
|
+
---
|
|
21
25
|
|
|
22
26
|
## Installation
|
|
23
27
|
|
|
24
28
|
```bash
|
|
25
|
-
|
|
26
|
-
npm install @xmachines/play-vue
|
|
29
|
+
pnpm add @xmachines/play-vue
|
|
27
30
|
```
|
|
28
31
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
- `PlayRenderer` (Vue component)
|
|
32
|
-
- `PlayRendererProps` (TypeScript interface)
|
|
32
|
+
**Peer dependencies** (install alongside):
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
```bash
|
|
35
|
+
pnpm add vue@^3.5.0 xstate@^5.31.0 @xstate/store@^3.17.0 @xmachines/json-render-vue@^0.18.0 @xmachines/json-render-core@^0.18.0 @xmachines/json-render-xstate@^0.18.0
|
|
36
|
+
```
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
---
|
|
37
39
|
|
|
38
40
|
## Quick Start
|
|
39
41
|
|
|
40
42
|
```vue
|
|
41
43
|
<!-- App.vue -->
|
|
44
|
+
<template>
|
|
45
|
+
<PlayUIProvider :actor="actor" :registryResult="registryResult">
|
|
46
|
+
<PlayRenderer />
|
|
47
|
+
</PlayUIProvider>
|
|
48
|
+
</template>
|
|
49
|
+
|
|
42
50
|
<script setup lang="ts">
|
|
51
|
+
import { defineRegistry, PlayUIProvider, PlayRenderer } from "@xmachines/play-vue";
|
|
43
52
|
import { definePlayer } from "@xmachines/play-xstate";
|
|
44
|
-
import {
|
|
45
|
-
import {
|
|
46
|
-
import
|
|
47
|
-
import
|
|
48
|
-
import Dashboard from "./components/Dashboard.vue";
|
|
49
|
-
|
|
50
|
-
// 1. Define catalog (business logic layer)
|
|
51
|
-
const catalog = defineCatalog({
|
|
52
|
-
LoginForm: z.object({ error: z.string().optional() }),
|
|
53
|
-
Dashboard: z.object({
|
|
54
|
-
userId: z.string(),
|
|
55
|
-
username: z.string(),
|
|
56
|
-
}),
|
|
57
|
-
});
|
|
53
|
+
import { myMachine } from "./machine.js";
|
|
54
|
+
import { myCatalog } from "./catalog.js";
|
|
55
|
+
import HomeSFC from "./views/Home.vue";
|
|
56
|
+
import LoginSFC from "./views/Login.vue";
|
|
58
57
|
|
|
59
|
-
|
|
60
|
-
const components = {
|
|
61
|
-
LoginForm,
|
|
62
|
-
Dashboard,
|
|
63
|
-
};
|
|
64
|
-
|
|
65
|
-
// 3. Create player actor (business logic runtime)
|
|
66
|
-
const createPlayer = definePlayer({ machine: authMachine, catalog });
|
|
58
|
+
const createPlayer = definePlayer({ machine: myMachine });
|
|
67
59
|
const actor = createPlayer();
|
|
68
60
|
actor.start();
|
|
69
|
-
</script>
|
|
70
61
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
62
|
+
const registryResult = defineRegistry(myCatalog, {
|
|
63
|
+
components: {
|
|
64
|
+
Home: HomeSFC, // .vue SFCs are auto-wrapped
|
|
65
|
+
Login: LoginSFC,
|
|
66
|
+
},
|
|
67
|
+
actions: {
|
|
68
|
+
login: async (args) => actor.send({ type: "auth.login", ...args }),
|
|
69
|
+
logout: async () => actor.send({ type: "auth.logout" }),
|
|
70
|
+
},
|
|
71
|
+
});
|
|
72
|
+
</script>
|
|
79
73
|
```
|
|
80
74
|
|
|
81
|
-
|
|
75
|
+
---
|
|
82
76
|
|
|
83
|
-
|
|
77
|
+
## API Summary
|
|
84
78
|
|
|
85
|
-
|
|
79
|
+
### Components
|
|
86
80
|
|
|
87
|
-
|
|
88
|
-
interface PlayRendererProps {
|
|
89
|
-
actor: AbstractActor<any>;
|
|
90
|
-
components: Record<string, Component>;
|
|
91
|
-
}
|
|
92
|
-
```
|
|
81
|
+
#### `<PlayUIProvider>`
|
|
93
82
|
|
|
94
|
-
**
|
|
83
|
+
Batteries-included composite provider. Wraps `<ActorProvider>` and `JSONUIProvider` in one component. **Recommended for most apps.**
|
|
95
84
|
|
|
96
|
-
|
|
97
|
-
|
|
85
|
+
| Prop | Type | Required | Description |
|
|
86
|
+
| --------------------- | -------------------------- | -------- | ------------------------------------------- |
|
|
87
|
+
| `actor` | `AbstractActor & Viewable` | ✅ | The XMachines actor instance |
|
|
88
|
+
| `registryResult` | `DefineRegistryResult` | ✅ | Result of `defineRegistry()` |
|
|
89
|
+
| `store` | `StateStore` | — | External controlled state store (optional) |
|
|
90
|
+
| `onRenderError` | `RenderErrorHandler` | — | Error handler for render failures |
|
|
91
|
+
| `navigate` | `(path: string) => void` | — | Link navigation function |
|
|
92
|
+
| `validationFunctions` | `Record<string, Function>` | — | Custom validation functions |
|
|
93
|
+
| `functions` | `Record<string, Function>` | — | Named functions for `$computed` expressions |
|
|
98
94
|
|
|
99
|
-
**Slots:**
|
|
95
|
+
**Slots:** `default` (rendered content), `fallback` (shown while actor view is `null`)
|
|
100
96
|
|
|
101
|
-
|
|
97
|
+
#### `<PlayRenderer>`
|
|
102
98
|
|
|
103
|
-
|
|
99
|
+
Zero-prop leaf component. Reads the current `spec` and `registry` from the nearest `<ActorProvider>` or `<PlayUIProvider>` context and renders via `<Renderer>`. Must be placed inside one of those providers.
|
|
104
100
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
101
|
+
```vue
|
|
102
|
+
<PlayUIProvider :actor="actor" :registryResult="registryResult">
|
|
103
|
+
<PlayRenderer />
|
|
104
|
+
</PlayUIProvider>
|
|
105
|
+
```
|
|
108
106
|
|
|
109
|
-
|
|
107
|
+
#### `<ActorProvider>`
|
|
110
108
|
|
|
111
|
-
|
|
112
|
-
<script setup lang="ts">
|
|
113
|
-
import type { AbstractActor } from "@xmachines/play-actor";
|
|
114
|
-
import { ref } from "vue";
|
|
115
|
-
|
|
116
|
-
const props = defineProps<{
|
|
117
|
-
error?: string;
|
|
118
|
-
send: AbstractActor<any>["send"];
|
|
119
|
-
}>();
|
|
120
|
-
|
|
121
|
-
const username = ref("");
|
|
122
|
-
|
|
123
|
-
function handleSubmit() {
|
|
124
|
-
props.send({
|
|
125
|
-
type: "auth.login",
|
|
126
|
-
username: username.value,
|
|
127
|
-
});
|
|
128
|
-
}
|
|
129
|
-
</script>
|
|
109
|
+
Low-level escape hatch for custom provider composition. Owns the full actor lifecycle — signal subscription, per-view state store, handler resolution, and Vue context provision. Use `<PlayUIProvider>` unless you need fine-grained control.
|
|
130
110
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
</template>
|
|
138
|
-
```
|
|
111
|
+
| Prop | Type | Required | Description |
|
|
112
|
+
| ---------------- | -------------------------- | -------- | ------------------------------- |
|
|
113
|
+
| `actor` | `AbstractActor & Viewable` | ✅ | The XMachines actor instance |
|
|
114
|
+
| `registryResult` | `DefineRegistryResult` | ✅ | Result of `defineRegistry()` |
|
|
115
|
+
| `store` | `StateStore` | — | External controlled state store |
|
|
116
|
+
| `onRenderError` | `RenderErrorHandler` | — | Override render error handler |
|
|
139
117
|
|
|
140
|
-
|
|
118
|
+
---
|
|
141
119
|
|
|
142
|
-
###
|
|
120
|
+
### Functions
|
|
143
121
|
|
|
144
|
-
|
|
145
|
-
<!-- App.vue -->
|
|
146
|
-
<script setup lang="ts">
|
|
147
|
-
import { PlayVueRouterProvider } from "@xmachines/play-vue-router";
|
|
148
|
-
import { PlayRenderer } from "@xmachines/play-vue";
|
|
149
|
-
import { provide } from "vue";
|
|
150
|
-
import Header from "./components/Header.vue";
|
|
151
|
-
import Footer from "./components/Footer.vue";
|
|
152
|
-
|
|
153
|
-
// Provide actor to nested components like Header
|
|
154
|
-
provide("actor", actor);
|
|
155
|
-
</script>
|
|
122
|
+
#### `defineRegistry(catalog, options)`
|
|
156
123
|
|
|
157
|
-
|
|
158
|
-
<PlayVueRouterProvider :actor="actor" :router="router" :routeMap="routeMap">
|
|
159
|
-
<template #default="{ currentActor, currentRouter }">
|
|
160
|
-
<div>
|
|
161
|
-
<Header />
|
|
162
|
-
<PlayRenderer :actor="currentActor" :components="components" />
|
|
163
|
-
<Footer />
|
|
164
|
-
</div>
|
|
165
|
-
</template>
|
|
166
|
-
</PlayVueRouterProvider>
|
|
167
|
-
</template>
|
|
168
|
-
```
|
|
124
|
+
Drop-in replacement for `defineRegistry` from `@xmachines/json-render-vue`. **Always import from `@xmachines/play-vue`** rather than `@xmachines/json-render-vue` when working with Vue SFCs — this wrapper automatically detects `.vue` SFCs in the `components` map and wraps them via `h()` so Vue composables (including `inject`-based ones) work correctly inside `<script setup>`.
|
|
169
125
|
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
import
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
const
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
pending = false;
|
|
188
|
-
for (const s of watcher.getPending()) s.get();
|
|
189
|
-
route.value = actor.currentRoute.get();
|
|
190
|
-
watcher.watch(actor.currentRoute);
|
|
191
|
-
});
|
|
192
|
-
}
|
|
193
|
-
});
|
|
194
|
-
route.value = actor.currentRoute.get();
|
|
195
|
-
watcher.watch(actor.currentRoute);
|
|
126
|
+
```typescript
|
|
127
|
+
import { defineRegistry } from "@xmachines/play-vue";
|
|
128
|
+
// NOT: import { defineRegistry } from "@xmachines/json-render-vue"
|
|
129
|
+
|
|
130
|
+
import LoginSFC from "./views/Login.vue";
|
|
131
|
+
import DashboardSFC from "./views/Dashboard.vue";
|
|
132
|
+
|
|
133
|
+
const registryResult = defineRegistry(catalog, {
|
|
134
|
+
components: {
|
|
135
|
+
Login: LoginSFC, // .vue SFC — auto-wrapped via h()
|
|
136
|
+
Dashboard: DashboardSFC,
|
|
137
|
+
},
|
|
138
|
+
actions: {
|
|
139
|
+
login: async (args, setState, getState) => {
|
|
140
|
+
/* ... */
|
|
141
|
+
},
|
|
142
|
+
},
|
|
196
143
|
});
|
|
144
|
+
```
|
|
197
145
|
|
|
198
|
-
|
|
199
|
-
if (watcher) watcher.unwatch(actor.currentRoute);
|
|
200
|
-
});
|
|
201
|
-
</script>
|
|
146
|
+
Plain `ComponentFn` functions (non-SFC) also work and are passed through unchanged. Mixing SFCs and plain functions in the same registry is supported.
|
|
202
147
|
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
148
|
+
#### `useActor()`
|
|
149
|
+
|
|
150
|
+
Vue composable for accessing the raw actor inside a `PlayRenderer` tree. Avoids prop drilling for deeply nested components.
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
import { useActor } from "@xmachines/play-vue";
|
|
154
|
+
|
|
155
|
+
// Inside a component rendered by PlayRenderer:
|
|
156
|
+
const actor = useActor();
|
|
157
|
+
actor.send({ type: "SUBMIT" });
|
|
208
158
|
```
|
|
209
159
|
|
|
210
|
-
|
|
160
|
+
Throws if called outside an `<ActorProvider>` or `<PlayUIProvider>` tree.
|
|
211
161
|
|
|
212
|
-
|
|
162
|
+
#### `getPlayViewContext()`
|
|
213
163
|
|
|
214
|
-
|
|
215
|
-
- No ref/reactive for business state
|
|
216
|
-
- No watch/watchEffect for business side effects
|
|
217
|
-
- Vue only triggers renders, doesn't control state
|
|
164
|
+
Access the current `ViewContextValue` — `{ spec, handlers, registry, store }` — from inside an `<ActorProvider>` tree.
|
|
218
165
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
- `actor.currentRoute.get()` provides navigation state
|
|
222
|
-
- Components observe signals via explicit watcher patterns
|
|
166
|
+
```typescript
|
|
167
|
+
import { getPlayViewContext } from "@xmachines/play-vue";
|
|
223
168
|
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
169
|
+
// Inside setup() of a component within an ActorProvider tree:
|
|
170
|
+
const view = getPlayViewContext();
|
|
171
|
+
// view.spec, view.handlers, view.registry, view.store
|
|
172
|
+
```
|
|
228
173
|
|
|
229
|
-
|
|
230
|
-
- `Signal.subtle.Watcher` coalesces rapid signal changes
|
|
231
|
-
- Prevents Vue thrashing from multiple signal updates
|
|
232
|
-
- Single Vue render per microtask batch
|
|
174
|
+
---
|
|
233
175
|
|
|
234
|
-
|
|
235
|
-
- Component teardown calls watcher `unwatch` in `onUnmounted`
|
|
236
|
-
- Do not rely on GC-only cleanup
|
|
176
|
+
### Re-exported from `@xmachines/json-render-vue`
|
|
237
177
|
|
|
238
|
-
|
|
178
|
+
The following are re-exported so consumers import everything from `@xmachines/play-vue`:
|
|
239
179
|
|
|
240
|
-
|
|
241
|
-
- Enables composition with navigation, headers, footers
|
|
242
|
-
- Supports multiple renderers in same app
|
|
180
|
+
**Components:** `JSONUIProvider`, `StateProvider`, `ActionProvider`, `VisibilityProvider`, `ValidationProvider`, `Renderer`
|
|
243
181
|
|
|
244
|
-
**
|
|
182
|
+
**Composables:** `useBoundProp`
|
|
245
183
|
|
|
246
|
-
|
|
247
|
-
- **Passive Infrastructure (INV-04):** Components reflect, never decide
|
|
184
|
+
**Types:** `JSONUIProviderProps`, `StateProviderProps`, `ActionProviderProps`, `ValidationProviderProps`, `RendererProps`, `ComponentFn`, `ComponentContext`, `DefineRegistryResult`
|
|
248
185
|
|
|
249
|
-
|
|
186
|
+
---
|
|
250
187
|
|
|
251
|
-
|
|
188
|
+
## Testing
|
|
252
189
|
|
|
253
|
-
|
|
254
|
-
2. Schedule work with `queueMicrotask`
|
|
255
|
-
3. Drain `watcher.getPending()`
|
|
256
|
-
4. Read actor signals and update Vue-local ref state
|
|
257
|
-
5. Re-arm with `watch(...)` or `watch()`
|
|
190
|
+
Run tests for this package in isolation:
|
|
258
191
|
|
|
259
|
-
|
|
192
|
+
```bash
|
|
193
|
+
# From the monorepo root
|
|
194
|
+
pnpm --filter @xmachines/play-vue test
|
|
260
195
|
|
|
261
|
-
|
|
196
|
+
# Watch mode
|
|
197
|
+
pnpm --filter @xmachines/play-vue run test:watch
|
|
262
198
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
- **Performance:** Microtask batching reduces unnecessary renders
|
|
267
|
-
- **Composability:** Renderer prop enables complex layouts
|
|
199
|
+
# With coverage (80% threshold enforced on lines, functions, branches, statements)
|
|
200
|
+
pnpm exec vitest run --coverage --config packages/play-vue/vitest.config.ts
|
|
201
|
+
```
|
|
268
202
|
|
|
269
|
-
|
|
203
|
+
Tests use [Vitest](https://vitest.dev/) with `jsdom` environment and `@vue/test-utils` for component mounting.
|
|
270
204
|
|
|
271
|
-
|
|
272
|
-
- **[@xmachines/play-catalog](../play-catalog/README.md)** - UI schema validation
|
|
273
|
-
- **[@xmachines/play-vue-router](../play-vue-router/README.md)** - Vue Router integration
|
|
274
|
-
- **[@xmachines/play-actor](../play-actor/README.md)** - Actor base
|
|
275
|
-
- **[@xmachines/play-signals](../play-signals/README.md)** - TC39 Signals primitives
|
|
205
|
+
---
|
|
276
206
|
|
|
277
207
|
## License
|
|
278
208
|
|
|
279
|
-
|
|
209
|
+
MIT — see [LICENSE](LICENSE).
|
|
210
|
+
|
|
211
|
+
@xmachines/play-vue - Vue 3 renderer for XMachines Play architecture
|
|
280
212
|
|
|
281
|
-
|
|
282
|
-
|
|
213
|
+
Provides a thin Vue rendering layer that passively observes actor signals
|
|
214
|
+
and renders UI components via @xmachines/json-render-vue. Vue reactivity is only used
|
|
215
|
+
to trigger re-renders — signals are the source of truth.
|
|
283
216
|
|
|
284
|
-
|
|
217
|
+
Re-exports `defineRegistry` (SFC-aware — auto-wraps `.vue` SFCs via `h()`),
|
|
218
|
+
`useBoundProp`, `ComponentFn`, `ComponentContext`, and all json-render providers
|
|
219
|
+
so consumers import everything from `@xmachines/play-vue` rather than
|
|
220
|
+
`@xmachines/json-render-vue` directly.
|
|
285
221
|
|
|
286
222
|
## Interfaces
|
|
287
223
|
|
|
288
|
-
- [
|
|
224
|
+
- [ActionProviderProps](interfaces/ActionProviderProps.md)
|
|
225
|
+
- [ActorProviderProps](interfaces/ActorProviderProps.md)
|
|
226
|
+
- [ComponentContext](interfaces/ComponentContext.md)
|
|
227
|
+
- [DefineRegistryResult](interfaces/DefineRegistryResult.md)
|
|
228
|
+
- [JSONUIProviderProps](interfaces/JSONUIProviderProps.md)
|
|
229
|
+
- [PlayUIProviderProps](interfaces/PlayUIProviderProps.md)
|
|
230
|
+
- [RendererProps](interfaces/RendererProps.md)
|
|
231
|
+
- [StateProviderProps](interfaces/StateProviderProps.md)
|
|
232
|
+
- [ValidationProviderProps](interfaces/ValidationProviderProps.md)
|
|
233
|
+
- [ViewContextValue](interfaces/ViewContextValue.md)
|
|
234
|
+
- [VisibilityProviderProps](interfaces/VisibilityProviderProps.md)
|
|
235
|
+
|
|
236
|
+
## Type Aliases
|
|
237
|
+
|
|
238
|
+
- [AnyPlayActor](type-aliases/AnyPlayActor.md)
|
|
239
|
+
- [ComponentEntry](type-aliases/ComponentEntry.md)
|
|
240
|
+
- [ComponentFn](type-aliases/ComponentFn.md)
|
|
241
|
+
- [ComponentsMap](type-aliases/ComponentsMap.md)
|
|
242
|
+
- [DefineRegistryOptions](type-aliases/DefineRegistryOptions.md)
|
|
243
|
+
- [RenderErrorHandler](type-aliases/RenderErrorHandler.md)
|
|
289
244
|
|
|
290
245
|
## Variables
|
|
291
246
|
|
|
247
|
+
- [ActionProvider](variables/ActionProvider.md)
|
|
248
|
+
- [JSONUIProvider](variables/JSONUIProvider.md)
|
|
292
249
|
- [PlayRenderer](variables/PlayRenderer.md)
|
|
250
|
+
- [Renderer](variables/Renderer.md)
|
|
251
|
+
- [StateProvider](variables/StateProvider.md)
|
|
252
|
+
- [ValidationProvider](variables/ValidationProvider.md)
|
|
253
|
+
- [VisibilityProvider](variables/VisibilityProvider.md)
|
|
254
|
+
|
|
255
|
+
## Functions
|
|
256
|
+
|
|
257
|
+
- [defineRegistry](functions/defineRegistry.md)
|
|
258
|
+
- [getPlayViewContext](functions/getPlayViewContext.md)
|
|
259
|
+
- [useActor](functions/useActor.md)
|
|
260
|
+
- [useBoundProp](functions/useBoundProp.md)
|
|
261
|
+
|
|
262
|
+
## References
|
|
263
|
+
|
|
264
|
+
### ActorProvider
|
|
265
|
+
|
|
266
|
+
Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
### PlayUIProvider
|
|
271
|
+
|
|
272
|
+
Renames and re-exports [PlayRenderer](variables/PlayRenderer.md)
|