@xmachines/docs 1.0.0-beta.43 → 1.0.0-beta.45
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/api/@xmachines/play/README.md +5 -5
- package/api/@xmachines/play/classes/NonNullableError.md +5 -5
- package/api/@xmachines/play/classes/PlayError.md +5 -5
- package/api/@xmachines/play/functions/assertNonNullable.md +2 -2
- package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
- package/api/@xmachines/play-actor/README.md +7 -7
- package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
- package/api/@xmachines/play-actor/functions/typedSpec.md +2 -2
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +6 -6
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +6 -6
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
- package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
- package/api/@xmachines/play-dom/README.md +3 -2
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +5 -5
- package/api/@xmachines/play-dom/functions/connectRenderer.md +2 -2
- package/api/@xmachines/play-dom/functions/createPlayUI.md +2 -2
- package/api/@xmachines/play-dom/functions/createRenderer.md +2 -2
- package/api/@xmachines/play-dom/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-dom/functions/renderSpec.md +2 -2
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +8 -8
- package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +14 -14
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -7
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +5 -5
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +13 -13
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +5 -5
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +4 -4
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +6 -6
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -6
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/Actions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +8 -8
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +3 -3
- package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DomSchema.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/SetState.md +2 -2
- package/api/@xmachines/play-dom/variables/schema.md +2 -2
- package/api/@xmachines/play-dom-router/README.md +13 -11
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +2 -2
- package/api/@xmachines/play-dom-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-dom-router/functions/createRouter.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +15 -15
- package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +15 -15
- package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +5 -5
- package/api/@xmachines/play-dom-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-react/README.md +10 -4
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +6 -6
- package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
- package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
- package/api/@xmachines/play-react/functions/Renderer.md +1 -1
- package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
- package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
- package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-react/functions/useActor.md +2 -2
- package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-react/functions/usePlayView.md +2 -2
- package/api/@xmachines/play-react/functions/useSignalEffect.md +2 -2
- package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +9 -9
- package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +5 -5
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ViewContextValue.md +6 -6
- package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-react/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-react/variables/ActorProvider.md +2 -2
- package/api/@xmachines/play-react/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +2 -2
- package/api/@xmachines/play-react-router/README.md +13 -7
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -30
- package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +25 -7
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +8 -8
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-router/README.md +14 -13
- package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +38 -34
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +2 -2
- package/api/@xmachines/play-router/functions/buildRouteTree.md +2 -2
- package/api/@xmachines/play-router/functions/createRouteMap.md +22 -36
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-router/functions/createRouteMatcher.md +53 -0
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +2 -2
- package/api/@xmachines/play-router/functions/extractQuery.md +2 -2
- package/api/@xmachines/play-router/functions/extractRouteParams.md +2 -2
- 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 +2 -2
- package/api/@xmachines/play-router/functions/isRouteReachable.md +2 -2
- package/api/@xmachines/play-router/functions/machineToGraph.md +2 -2
- package/api/@xmachines/play-router/functions/routeExists.md +2 -2
- package/api/@xmachines/play-router/functions/sanitizePathname.md +2 -2
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +2 -2
- package/api/@xmachines/play-router/functions/validateStateExists.md +2 -2
- package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +5 -5
- package/api/@xmachines/play-router/interfaces/LocationLike.md +4 -4
- package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +4 -4
- package/api/@xmachines/play-router/interfaces/MachineNodeData.md +6 -6
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteMatch.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteMatcher.md +9 -9
- package/api/@xmachines/play-router/interfaces/RouteNode.md +13 -13
- package/api/@xmachines/play-router/interfaces/RouteObject.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-router/interfaces/WindowLike.md +4 -4
- package/api/@xmachines/play-router/type-aliases/MachineGraph.md +2 -2
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +2 -2
- package/api/@xmachines/play-signals/README.md +3 -3
- package/api/@xmachines/play-signals/functions/watchSignal.md +2 -2
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +3 -3
- 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 +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
- 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 +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +2 -2
- package/api/@xmachines/play-solid/README.md +11 -5
- package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
- package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-solid/functions/useAction.md +1 -1
- package/api/@xmachines/play-solid/functions/useActions.md +1 -1
- package/api/@xmachines/play-solid/functions/useActor.md +2 -2
- package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
- package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
- package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
- package/api/@xmachines/play-solid/functions/usePlayView.md +2 -2
- package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
- package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
- package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
- package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +9 -9
- package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
- package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +6 -6
- package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
- package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-solid/variables/ActorContext.md +2 -2
- package/api/@xmachines/play-solid/variables/ActorProvider.md +2 -2
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +2 -2
- package/api/@xmachines/play-solid-router/README.md +18 -13
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -31
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +5 -5
- package/api/@xmachines/play-svelte/README.md +9 -2
- package/api/@xmachines/play-svelte/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-svelte/functions/getActorContext.md +2 -2
- package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +2 -2
- package/api/@xmachines/play-svelte/functions/setActorContext.md +2 -2
- package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +13 -9
- package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +5 -5
- package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +43 -0
- package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +6 -6
- package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
- package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/README.md +7 -1
- package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-sveltekit-router/README.md +8 -2
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +2 -2
- package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/README.md +15 -9
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -30
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +25 -7
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +12 -11
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +8 -8
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/README.md +17 -11
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -31
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +9 -8
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/README.md +12 -6
- package/api/@xmachines/play-vue/functions/defineRegistry.md +2 -2
- package/api/@xmachines/play-vue/functions/getPlayViewContext.md +2 -2
- package/api/@xmachines/play-vue/functions/useActor.md +2 -2
- package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +6 -6
- package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
- package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
- package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +9 -9
- package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
- package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +6 -6
- package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +5 -0
- package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +3 -3
- package/api/@xmachines/play-vue/type-aliases/PlayActor.md +2 -2
- package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +2 -2
- package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
- package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
- package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
- package/api/@xmachines/play-vue-router/README.md +18 -13
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +41 -31
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +26 -6
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +8 -8
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +13 -0
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +5 -5
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-xstate/README.md +11 -11
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +2 -2
- package/api/@xmachines/play-xstate/functions/composeGuards.md +2 -2
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +2 -2
- package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +5 -3
- package/api/@xmachines/play-xstate/functions/definePlayer.md +3 -3
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +3 -3
- package/api/@xmachines/play-xstate/functions/eventMatches.md +2 -2
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +2 -2
- package/api/@xmachines/play-xstate/functions/hasContext.md +2 -2
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +2 -2
- package/api/@xmachines/play-xstate/functions/negateGuard.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +6 -6
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +5 -5
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +5 -5
- package/api/@xmachines/shared/README.md +1 -1
- package/api/@xmachines/shared/vite-aliases/README.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +2 -2
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +2 -2
- package/api/@xmachines/shared/vitest/README.md +1 -1
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +2 -2
- package/api/llms.txt +2 -2
- package/examples/@xmachines/play-dom-demo/README.md +4 -4
- package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +2 -2
- package/examples/@xmachines/play-dom-demo/functions/initShell.md +2 -2
- package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-dom-router-demo/README.md +5 -5
- package/examples/@xmachines/play-react-demo/README.md +4 -4
- package/examples/@xmachines/play-react-demo/functions/App.md +2 -2
- package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/NavBar.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Shell.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-react-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-react-router-demo/README.md +4 -4
- package/examples/@xmachines/play-solid-demo/README.md +4 -4
- package/examples/@xmachines/play-solid-demo/functions/App.md +2 -2
- package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/About.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Contact.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Home.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Login.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/NavBar.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Navigation.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Overview.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Profile.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Settings.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Shell.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/Stats.md +2 -2
- package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-solid-router-demo/README.md +5 -5
- package/examples/@xmachines/play-svelte-demo/README.md +3 -3
- package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-svelte-spa-router-demo/README.md +4 -4
- package/examples/@xmachines/play-sveltekit-router-demo/README.md +4 -4
- package/examples/@xmachines/play-tanstack-react-router-demo/README.md +5 -5
- package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +6 -6
- package/examples/@xmachines/play-vue-demo/README.md +4 -4
- package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +2 -2
- package/examples/@xmachines/play-vue-demo/variables/App.md +2 -2
- package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +2 -2
- package/examples/@xmachines/play-vue-router-demo/README.md +4 -4
- package/package.json +2 -2
- package/rfc/play.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMapFromMachine.md +0 -38
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteWatcherHandle
|
|
2
2
|
|
|
3
3
|
# Interface: RouteWatcherHandle
|
|
4
4
|
|
|
5
|
-
Defined in: [router-bridge-base.ts:
|
|
5
|
+
Defined in: [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L71)
|
|
6
6
|
|
|
7
7
|
Narrow interface for the TC39 Signal watcher used by `RouterBridgeBase` to
|
|
8
8
|
monitor `actor.currentRoute` changes.
|
|
@@ -24,7 +24,7 @@ created and managed internally by `RouterBridgeBase`.
|
|
|
24
24
|
unwatch(): void;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [router-bridge-base.ts:
|
|
27
|
+
Defined in: [router-bridge-base.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L75)
|
|
28
28
|
|
|
29
29
|
Stop observing and release the watcher.
|
|
30
30
|
|
|
@@ -40,7 +40,7 @@ Stop observing and release the watcher.
|
|
|
40
40
|
watch(signal): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [router-bridge-base.ts:
|
|
43
|
+
Defined in: [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/router-bridge-base.ts#L73)
|
|
44
44
|
|
|
45
45
|
Arm the watcher to observe the given signal.
|
|
46
46
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouterBridge
|
|
2
2
|
|
|
3
3
|
# Interface: RouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [types.ts:271](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L271)
|
|
6
6
|
|
|
7
7
|
RouterBridge interface for runtime infrastructure adapters
|
|
8
8
|
|
|
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
|
|
|
44
44
|
|
|
45
45
|
## See
|
|
46
46
|
|
|
47
|
-
[Play RFC](
|
|
47
|
+
[Play RFC](../../../../rfc/play.md) - Invariant INV-04
|
|
48
48
|
|
|
49
49
|
## Methods
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
|
|
|
54
54
|
connect(): void | Promise<void>;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
57
|
+
Defined in: [types.ts:287](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L287)
|
|
58
58
|
|
|
59
59
|
Connect the router bridge to the Actor
|
|
60
60
|
|
|
@@ -83,7 +83,7 @@ await bridge.connect();
|
|
|
83
83
|
disconnect(): void | Promise<void>;
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
86
|
+
Defined in: [types.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L303)
|
|
87
87
|
|
|
88
88
|
Disconnect the router bridge from the Actor
|
|
89
89
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-router](../README.md) / WindowLike
|
|
2
2
|
|
|
3
3
|
# Interface: WindowLike
|
|
4
4
|
|
|
5
|
-
Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [types.ts:324](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L324)
|
|
6
6
|
|
|
7
7
|
Minimal window interface required by adapters that subscribe to DOM events
|
|
8
8
|
(e.g. `hashchange`). Injectable for SSR and testing — pass a mock instead of
|
|
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
|
|
|
30
30
|
addEventListener(type, listener): void;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
33
|
+
Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L325)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -51,7 +51,7 @@ Defined in: [types.ts:325](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.
|
|
|
51
51
|
removeEventListener(type, listener): void;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
54
|
+
Defined in: [types.ts:326](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L326)
|
|
55
55
|
|
|
56
56
|
#### Parameters
|
|
57
57
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineGraph
|
|
2
2
|
|
|
3
3
|
# Type Alias: MachineGraph
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type MachineGraph = Graph<MachineNodeData, MachineEdgeData>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [machine-to-graph.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [machine-to-graph.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/machine-to-graph.ts#L18)
|
|
10
10
|
|
|
11
11
|
Typed @statelyai/graph Graph representing a state machine.
|
|
12
12
|
Provides hierarchy queries, traversal algorithms, and reachability checks.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMetadata
|
|
2
2
|
|
|
3
3
|
# Type Alias: RouteMetadata
|
|
4
4
|
|
|
@@ -6,6 +6,6 @@
|
|
|
6
6
|
type RouteMetadata = string | RouteObject;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-router/src/types.ts#L49)
|
|
10
10
|
|
|
11
11
|
Route metadata from state machine `meta.route` field.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../README.md) / @xmachines/play-signals
|
|
2
2
|
|
|
3
3
|
# @xmachines/play-signals
|
|
4
4
|
|
|
@@ -116,7 +116,7 @@ Always dispose explicitly. Do not rely on GC-only cleanup guidance.
|
|
|
116
116
|
|
|
117
117
|
- [TC39 Signals Proposal](https://github.com/tc39/proposal-signals)
|
|
118
118
|
- [signal-polyfill](https://github.com/proposal-signals/signal-polyfill)
|
|
119
|
-
- [Play RFC](
|
|
119
|
+
- [Play RFC](../../../rfc/play.md)
|
|
120
120
|
|
|
121
121
|
## License
|
|
122
122
|
|
|
@@ -159,7 +159,7 @@ count.set(5); // Logs: Count: 5 Doubled: 10
|
|
|
159
159
|
|
|
160
160
|
## See
|
|
161
161
|
|
|
162
|
-
- [Play RFC](
|
|
162
|
+
- [Play RFC](../../../rfc/play.md) - Invariant INV-05
|
|
163
163
|
- [TC39 Signals Proposal](https://github.com/tc39/proposal-signals)
|
|
164
164
|
|
|
165
165
|
## Remarks
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / watchSignal
|
|
2
2
|
|
|
3
3
|
# Function: watchSignal()
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function watchSignal<T>(signal, onValue): () => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-signals/src/watch-signal.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/watch-signal.ts#L21)
|
|
10
10
|
|
|
11
11
|
Subscribe to a single signal using the canonical one-shot watcher lifecycle.
|
|
12
12
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / ComputedOptions
|
|
2
2
|
|
|
3
3
|
# Interface: ComputedOptions\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L84)
|
|
6
6
|
|
|
7
7
|
Options for creating Signal.Computed
|
|
8
8
|
|
|
@@ -31,4 +31,4 @@ const options: ComputedOptions<string> = {
|
|
|
31
31
|
|
|
32
32
|
| Property | Type | Description | Defined in |
|
|
33
33
|
| -------------------------------------- | ----------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
34
|
-
| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
34
|
+
| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L88) |
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalComputed
|
|
2
2
|
|
|
3
3
|
# Interface: SignalComputed\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L111)
|
|
6
6
|
|
|
7
7
|
Lazily-evaluated, memoized computed signal
|
|
8
8
|
|
|
@@ -38,7 +38,7 @@ console.log(doubled.get()); // 10 (memoized, not recomputed)
|
|
|
38
38
|
get(): T;
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
41
|
+
Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L117)
|
|
42
42
|
|
|
43
43
|
Read computed value (recalculates only if dependencies changed)
|
|
44
44
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalOptions
|
|
2
2
|
|
|
3
3
|
# Interface: SignalOptions\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L26)
|
|
6
6
|
|
|
7
7
|
Options for creating Signal.State
|
|
8
8
|
|
|
@@ -32,4 +32,4 @@ const count = new Signal.State(0, options);
|
|
|
32
32
|
|
|
33
33
|
| Property | Type | Description | Defined in |
|
|
34
34
|
| -------------------------------------- | ----------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
35
|
-
| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
35
|
+
| <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L33) |
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalState
|
|
2
2
|
|
|
3
3
|
# Interface: SignalState\<T\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L53)
|
|
6
6
|
|
|
7
7
|
Writable state signal holding a single reactive value
|
|
8
8
|
|
|
@@ -35,7 +35,7 @@ console.log(name.get()); // 'Bob'
|
|
|
35
35
|
get(): T;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
38
|
+
Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L59)
|
|
39
39
|
|
|
40
40
|
Read current value and track as dependency
|
|
41
41
|
|
|
@@ -53,7 +53,7 @@ Current value of the signal
|
|
|
53
53
|
set(value): void;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
56
|
+
Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L66)
|
|
57
57
|
|
|
58
58
|
Write new value and notify watchers if changed
|
|
59
59
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / SignalWatcher
|
|
2
2
|
|
|
3
3
|
# Interface: SignalWatcher
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L167)
|
|
6
6
|
|
|
7
7
|
Watcher for observing signal changes and scheduling effects
|
|
8
8
|
|
|
@@ -40,7 +40,7 @@ getPending(): (
|
|
|
40
40
|
| SignalComputed<unknown>)[];
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
43
|
+
Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L187)
|
|
44
44
|
|
|
45
45
|
Get signals that changed since last check
|
|
46
46
|
|
|
@@ -60,7 +60,7 @@ Array of signals that have pending updates
|
|
|
60
60
|
unwatch(signal): void;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
63
|
+
Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L180)
|
|
64
64
|
|
|
65
65
|
Stop watching a signal
|
|
66
66
|
|
|
@@ -82,7 +82,7 @@ Stop watching a signal
|
|
|
82
82
|
watch(signal): void;
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
85
|
+
Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L173)
|
|
86
86
|
|
|
87
87
|
Start watching a signal for changes
|
|
88
88
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / Computed
|
|
2
2
|
|
|
3
3
|
# Class: Computed\<T\>
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / Options
|
|
2
2
|
|
|
3
3
|
# Interface: Options\<T\>
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../README.md) / [@xmachines/play-signals](../../../../README.md) / [Signal](../../README.md) / subtle
|
|
2
2
|
|
|
3
3
|
# subtle
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / Watcher
|
|
2
2
|
|
|
3
3
|
# Class: Watcher
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / currentComputed
|
|
2
2
|
|
|
3
3
|
# Function: currentComputed()
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / hasSinks
|
|
2
2
|
|
|
3
3
|
# Function: hasSinks()
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / hasSources
|
|
2
2
|
|
|
3
3
|
# Function: hasSources()
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / introspectSinks
|
|
2
2
|
|
|
3
3
|
# Function: introspectSinks()
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / introspectSources
|
|
2
2
|
|
|
3
3
|
# Function: introspectSources()
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / untrack
|
|
2
2
|
|
|
3
3
|
# Function: untrack()
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / unwatched
|
|
2
2
|
|
|
3
3
|
# Variable: unwatched
|
|
4
4
|
|
package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../../../README.md) / [@xmachines/play-signals](../../../../../README.md) / [Signal](../../../README.md) / [subtle](../README.md) / watched
|
|
2
2
|
|
|
3
3
|
# Variable: watched
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / isComputed
|
|
2
2
|
|
|
3
3
|
# Variable: isComputed
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../../../README.md) / [@xmachines/play-signals](../../../README.md) / [Signal](../README.md) / isWatcher
|
|
2
2
|
|
|
3
3
|
# Variable: isWatcher
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-signals](../README.md) / WatcherNotify
|
|
2
2
|
|
|
3
3
|
# Type Alias: WatcherNotify
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type WatcherNotify = () => void;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-signals/src/types.ts#L139)
|
|
10
10
|
|
|
11
11
|
Notification callback for Signal.subtle.Watcher
|
|
12
12
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../README.md) / @xmachines/play-solid
|
|
2
2
|
|
|
3
3
|
# @xmachines/play-solid
|
|
4
4
|
|
|
@@ -15,7 +15,7 @@ Bridges TC39 Signal-driven actors to Solid's fine-grained reactivity. Business l
|
|
|
15
15
|
- Routes action names from spec elements to `actor.send()` via the `actions` prop
|
|
16
16
|
- Manages per-view UI state in an `@xstate/store` atom (automatic or caller-supplied)
|
|
17
17
|
|
|
18
|
-
Per [Play RFC](
|
|
18
|
+
Per [Play RFC](../../../rfc/play.md):
|
|
19
19
|
|
|
20
20
|
- **Actor Authority (INV-01):** Guards in the machine decide all state transitions
|
|
21
21
|
- **Passive Infrastructure (INV-04):** Solid observes signals and dispatches events — never decides
|
|
@@ -196,7 +196,7 @@ Batteries-included composite provider. Wraps `ActorProvider` + `JSONUIProvider`.
|
|
|
196
196
|
|
|
197
197
|
**`actor`** — A `PlayerActor` (or any `AbstractActor & Viewable`). Provides the `currentView` signal.
|
|
198
198
|
|
|
199
|
-
**`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from
|
|
199
|
+
**`registryResult`** — The full `DefineRegistryResult` returned by `defineRegistry(catalog, { components, actions })` from.
|
|
200
200
|
|
|
201
201
|
**`store`** (optional) — Controls per-view UI state (`$state` bindings, form values):
|
|
202
202
|
|
|
@@ -302,7 +302,7 @@ const registryResult = defineRegistry(catalog, {
|
|
|
302
302
|
});
|
|
303
303
|
```
|
|
304
304
|
|
|
305
|
-
`onRenderError` is typed as `RenderErrorHandler` and exported from
|
|
305
|
+
`onRenderError` is typed as `RenderErrorHandler` and exported from.
|
|
306
306
|
|
|
307
307
|
---
|
|
308
308
|
|
|
@@ -343,7 +343,13 @@ Priority: **route param fills `undefined` slots; explicit non-`undefined` spec p
|
|
|
343
343
|
- SolidJS signals are only used to trigger re-renders — not for business logic
|
|
344
344
|
- `actor.currentView` (TC39 Signal) is bridged into a SolidJS `createSignal` inside `PlayRenderer`
|
|
345
345
|
- Per-view UI state lives in an `@xstate/store` atom, not in SolidJS reactive state
|
|
346
|
-
- `@json-render/solid` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useBoundProp` from
|
|
346
|
+
- `@json-render/solid` drives rendering; `PlayRenderer` is the signal bridge — import `defineRegistry`, `ComponentFn`, `ComponentContext`, and `useBoundProp` from
|
|
347
|
+
|
|
348
|
+
## Learn More
|
|
349
|
+
|
|
350
|
+
- [Demo](../../../examples/@xmachines/play-solid-demo/README.md)
|
|
351
|
+
- [Solid Router adapter](../play-solid-router/README.md)
|
|
352
|
+
- [TanStack Solid Router adapter](../play-tanstack-solid-router/README.md)
|
|
347
353
|
|
|
348
354
|
@xmachines/play-solid - SolidJS renderer for XMachines Play architecture
|
|
349
355
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useActor
|
|
2
2
|
|
|
3
3
|
# Function: useActor()
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function useActor(): PlayActor;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-solid/src/useActor.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-solid/src/useActor.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-solid/src/useActor.ts#L36)
|
|
10
10
|
|
|
11
11
|
## Returns
|
|
12
12
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-solid](../README.md) / usePlayView
|
|
2
2
|
|
|
3
3
|
# Function: usePlayView()
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function usePlayView(): ViewContextValue;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-solid/src/ActorProvider.tsx:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-solid/src/ActorProvider.tsx:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.45/packages/play-solid/src/ActorProvider.tsx#L69)
|
|
10
10
|
|
|
11
11
|
Hook to access the current view context inside an ActorProvider tree.
|
|
12
12
|
|