@xmachines/docs 1.0.0-beta.44 → 1.0.0-beta.46
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 +4 -4
- 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 +3 -3
- package/api/@xmachines/play-actor/README.md +5 -5
- 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 +12 -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 +2 -2
- package/api/@xmachines/play-dom-router/functions/createRouter.md +2 -2
- 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 +7 -7
- 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 +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +4 -4
- 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 +9 -3
- 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 +12 -7
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +24 -24
- 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 +2 -2
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
- package/api/@xmachines/play-router/README.md +5 -5
- package/api/@xmachines/play-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +24 -24
- 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 +2 -2
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-router/functions/createRouteMatcher.md +2 -2
- 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 +7 -7
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +9 -9
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +3 -3
- 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 +5 -5
- package/api/@xmachines/play-router/interfaces/RouteNode.md +11 -11
- 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 +4 -4
- 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 +1 -1
- 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 +10 -4
- 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 +16 -12
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +25 -25
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +2 -2
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
- 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 +8 -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 +9 -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 +12 -12
- 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 +6 -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 +2 -2
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +5 -5
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +4 -4
- 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 +7 -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 +2 -2
- 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 +7 -7
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +4 -4
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/README.md +14 -9
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +24 -24
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +3 -3
- 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 +4 -4
- 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 +15 -10
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +25 -25
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +6 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
- 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 +10 -5
- 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 +2 -2
- 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 +16 -12
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +25 -25
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +2 -2
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +3 -3
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
- 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 +10 -10
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +13 -13
- 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 +2 -2
- package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
- 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/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
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayUIProviderProps
|
|
2
2
|
|
|
3
3
|
# Interface: PlayUIProviderProps
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/types.ts#L25)
|
|
6
6
|
|
|
7
7
|
Props for the ActorProvider component.
|
|
8
8
|
Extracted to types.ts so TypeScript can re-export without the vue-shim limitation.
|
|
@@ -15,10 +15,10 @@ Extracted to types.ts so TypeScript can re-export without the vue-shim limitatio
|
|
|
15
15
|
|
|
16
16
|
| Property | Type | Description | Inherited from | Defined in |
|
|
17
17
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
-
| <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
19
|
-
| <a id="property-functions"></a> `functions?` | `Record`\<`string`, (`args?`, `state?`) => `unknown`\> | Named functions for $computed expressions in props | - | [packages/play-vue/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
20
|
-
| <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigate function forwarded to JSONUIProvider for link resolution | - | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
21
|
-
| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
22
|
-
| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
23
|
-
| <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
24
|
-
| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Validation functions forwarded to JSONUIProvider | - | [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
18
|
+
| <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L154) |
|
|
19
|
+
| <a id="property-functions"></a> `functions?` | `Record`\<`string`, (`args?`, `state?`) => `unknown`\> | Named functions for $computed expressions in props | - | [packages/play-vue/src/types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/types.ts#L34) |
|
|
20
|
+
| <a id="property-navigate"></a> `navigate?` | (`path`) => `void` | Navigate function forwarded to JSONUIProvider for link resolution | - | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/types.ts#L27) |
|
|
21
|
+
| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L167) |
|
|
22
|
+
| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md) | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L156) |
|
|
23
|
+
| <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`ActorProviderProps`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L162) |
|
|
24
|
+
| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\> | Validation functions forwarded to JSONUIProvider | - | [packages/play-vue/src/types.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/types.ts#L29) |
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ViewContextValue
|
|
2
2
|
|
|
3
3
|
# Interface: ViewContextValue
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-vue/src/actor-provider-context.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/actor-provider-context.ts#L21)
|
|
6
6
|
|
|
7
7
|
Context value provided by ActorProvider and consumed by PlayRenderer (zero-prop leaf).
|
|
8
8
|
Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree.
|
|
@@ -15,7 +15,7 @@ Accessible via getPlayViewContext() inside any ActorProvider/PlayUIProvider tree
|
|
|
15
15
|
|
|
16
16
|
| Property | Type | Description | Inherited from | Defined in |
|
|
17
17
|
| ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
18
|
-
| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
19
|
-
| <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
20
|
-
| <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
21
|
-
| <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
18
|
+
| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\> | Action handlers resolved against the live StateStore. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L122) |
|
|
19
|
+
| <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from registryResult.registry. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L124) |
|
|
20
|
+
| <a id="property-spec"></a> `spec` | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec) | [packages/play-actor/src/abstract-actor.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L120) |
|
|
21
|
+
| <a id="property-store"></a> `store` | `StateStore` | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store) | [packages/play-actor/src/abstract-actor.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-actor/src/abstract-actor.ts#L126) |
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / VisibilityProviderProps
|
|
2
2
|
|
|
3
3
|
# Interface: VisibilityProviderProps
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [packages/play-vue/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/types.ts#L23)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentEntry
|
|
2
2
|
|
|
3
3
|
# Type Alias: ComponentEntry\<C, K\>
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/define-registry.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/define-registry.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/define-registry.ts#L105)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / ComponentsMap
|
|
2
2
|
|
|
3
3
|
# Type Alias: ComponentsMap\<C\>
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/define-registry.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/define-registry.ts#L109)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / DefineRegistryOptions
|
|
2
2
|
|
|
3
3
|
# Type Alias: DefineRegistryOptions\<C\>
|
|
4
4
|
|
|
@@ -7,13 +7,13 @@ type DefineRegistryOptions<C> = Omit<Parameters<typeof defineRegistryBase>[1], "
|
|
|
7
7
|
object;
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
10
|
+
Defined in: [packages/play-vue/src/define-registry.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/define-registry.ts#L113)
|
|
11
11
|
|
|
12
12
|
## Type Declaration
|
|
13
13
|
|
|
14
14
|
| Name | Type | Defined in |
|
|
15
15
|
| ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
16
|
-
| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
16
|
+
| `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/define-registry.ts#L117) |
|
|
17
17
|
|
|
18
18
|
## Type Parameters
|
|
19
19
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayActor
|
|
2
2
|
|
|
3
3
|
# Type Alias: PlayActor
|
|
4
4
|
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
type PlayActor = AbstractActor<AnyActorLogic>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/useActor.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/useActor.ts#L26)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayRenderer
|
|
2
2
|
|
|
3
3
|
# Variable: PlayRenderer
|
|
4
4
|
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
const PlayRenderer: DefineComponent<{}, {}, unknown>;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue/src/vue-shim.d.ts#L3)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../README.md) / @xmachines/play-vue-router
|
|
2
2
|
|
|
3
3
|
# @xmachines/play-vue-router
|
|
4
4
|
|
|
@@ -40,10 +40,10 @@ npm install vue-router@^4.0.0 vue@^3.5.0 @xmachines/play-vue-router @xmachines/p
|
|
|
40
40
|
|
|
41
41
|
- `vue-router` ^4.0.0 || ^5.0.0 — Vue Router library
|
|
42
42
|
- `vue` ^3.5.0 — Vue runtime
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
43
|
+
-)
|
|
44
|
+
- — Actor base
|
|
45
|
+
- — Route extraction
|
|
46
|
+
- — TC39 Signals primitives
|
|
47
47
|
|
|
48
48
|
## Quick Start
|
|
49
49
|
|
|
@@ -476,7 +476,7 @@ onUnmounted(() => {
|
|
|
476
476
|
|
|
477
477
|
## Error Handling
|
|
478
478
|
|
|
479
|
-
All runtime errors thrown by this package extend `PlayError` from
|
|
479
|
+
All runtime errors thrown by this package extend `PlayError` from and
|
|
480
480
|
are exported from the `./errors` subpath:
|
|
481
481
|
|
|
482
482
|
```typescript
|
|
@@ -552,13 +552,12 @@ private syncActorFromRouter(to: RouteLocation): void {
|
|
|
552
552
|
|
|
553
553
|
**Package Dependencies:**
|
|
554
554
|
|
|
555
|
-
-
|
|
556
|
-
- `@xmachines/play-actor` - Actor base class with signal protocol
|
|
557
|
-
- `@xmachines/play-router` - Route extraction and tree building
|
|
558
|
-
- `@xmachines/play-signals` - TC39 Signals polyfill for reactivity
|
|
559
|
-
- `@xmachines/play-xstate` - XState integration via `definePlayer()`
|
|
555
|
+
-)
|
|
560
556
|
|
|
561
|
-
|
|
557
|
+
- - Actor base class with signal protocol
|
|
558
|
+
- - Route extraction and tree building
|
|
559
|
+
- - TC39 Signals polyfill for reactivity
|
|
560
|
+
- **Architecture Layers:**
|
|
562
561
|
|
|
563
562
|
```
|
|
564
563
|
┌─────────────────────────────────────┐
|
|
@@ -618,6 +617,11 @@ router.afterEach((to) => {
|
|
|
618
617
|
|
|
619
618
|
**Why it happens:** Vue Router's global `route` object updates asynchronously during navigation. The `to` parameter in `afterEach` is the destination route with correct params.
|
|
620
619
|
|
|
620
|
+
## Learn More
|
|
621
|
+
|
|
622
|
+
- [Demo](../../../examples/@xmachines/play-vue-router-demo/README.md)
|
|
623
|
+
- [Vue renderer](../play-vue/README.md)
|
|
624
|
+
|
|
621
625
|
## License
|
|
622
626
|
|
|
623
627
|
Copyright (c) 2016 [Mikael Karon](mailto:mikael@karon.se). All rights reserved.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / RouteMap
|
|
2
2
|
|
|
3
3
|
# Class: RouteMap
|
|
4
4
|
|
|
5
|
-
Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L100)
|
|
6
6
|
|
|
7
7
|
Shared bidirectional route map base class.
|
|
8
8
|
|
|
@@ -50,7 +50,7 @@ map.getPathByStateId("missing"); // null
|
|
|
50
50
|
new RouteMap(mappings, options?): RouteMap;
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
53
|
+
Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L125)
|
|
54
54
|
|
|
55
55
|
Build a route map from an array of state ID ↔ path mappings.
|
|
56
56
|
|
|
@@ -78,7 +78,7 @@ buckets for efficient candidate selection.
|
|
|
78
78
|
getPathByStateId(stateId): string | null;
|
|
79
79
|
```
|
|
80
80
|
|
|
81
|
-
Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
81
|
+
Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L209)
|
|
82
82
|
|
|
83
83
|
Look up the path pattern registered for a state ID.
|
|
84
84
|
|
|
@@ -109,7 +109,7 @@ map.getPathByStateId("missing"); // null
|
|
|
109
109
|
getStateIdByPath(path): string | null;
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
112
|
+
Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/base-route-map.ts#L174)
|
|
113
113
|
|
|
114
114
|
Resolve a URL path to its mapped state ID.
|
|
115
115
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / VueRouterBridge
|
|
2
2
|
|
|
3
3
|
# Class: VueRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
5
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L33)
|
|
6
6
|
|
|
7
7
|
@xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
|
|
8
8
|
|
|
@@ -23,7 +23,7 @@ new VueRouterBridge(
|
|
|
23
23
|
routeMap): VueRouterBridge;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
26
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L42)
|
|
27
27
|
|
|
28
28
|
#### Parameters
|
|
29
29
|
|
|
@@ -45,15 +45,15 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:42](https://gitlab.com/xma
|
|
|
45
45
|
|
|
46
46
|
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|
|
47
47
|
| --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
48
|
-
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
49
|
-
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
50
|
-
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
51
|
-
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
52
|
-
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
53
|
-
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
54
|
-
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
55
|
-
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
56
|
-
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
48
|
+
| <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L126) |
|
|
49
|
+
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L104) |
|
|
50
|
+
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L103) |
|
|
51
|
+
| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L116) |
|
|
52
|
+
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L105) |
|
|
53
|
+
| <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L127) |
|
|
54
|
+
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L129) |
|
|
55
|
+
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L128) |
|
|
56
|
+
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L117) |
|
|
57
57
|
|
|
58
58
|
## Methods
|
|
59
59
|
|
|
@@ -63,7 +63,7 @@ Defined in: [play-vue-router/src/vue-router-bridge.ts:42](https://gitlab.com/xma
|
|
|
63
63
|
connect(): void;
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
66
|
+
Defined in: [play-router/src/router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L153)
|
|
67
67
|
|
|
68
68
|
Connect the router bridge to the Actor.
|
|
69
69
|
|
|
@@ -95,7 +95,7 @@ Adapters that need custom initial-sync behavior should override
|
|
|
95
95
|
disconnect(): void;
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
98
|
+
Defined in: [play-router/src/router-bridge-base.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L249)
|
|
99
99
|
|
|
100
100
|
Disconnect the router bridge from the Actor.
|
|
101
101
|
|
|
@@ -117,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
117
117
|
dispose(): void;
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
120
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L193)
|
|
121
121
|
|
|
122
122
|
Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`).
|
|
123
123
|
|
|
@@ -133,7 +133,7 @@ Cleanup alias for Vue component lifecycle (`onUnmounted(() => bridge.dispose())`
|
|
|
133
133
|
protected extractParams(pathname, stateId): Record<string, string>;
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
136
|
+
Defined in: [play-router/src/router-bridge-base.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L373)
|
|
137
137
|
|
|
138
138
|
Extract path parameters from URL using the URLPattern API.
|
|
139
139
|
|
|
@@ -171,7 +171,7 @@ When URLPattern is absent and the route is parameterized
|
|
|
171
171
|
protected extractQuery(search): Record<string, string>;
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
-
Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
174
|
+
Defined in: [play-router/src/router-bridge-base.ts:410](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L410)
|
|
175
175
|
|
|
176
176
|
Extract query parameters from URL search string.
|
|
177
177
|
|
|
@@ -199,7 +199,7 @@ Extracted query parameters or empty object
|
|
|
199
199
|
protected getInitialRouterPath(): string | null;
|
|
200
200
|
```
|
|
201
201
|
|
|
202
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
202
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L173)
|
|
203
203
|
|
|
204
204
|
Return the router's current pathname at connect() time.
|
|
205
205
|
|
|
@@ -235,7 +235,7 @@ bridges that have not yet implemented this hook.
|
|
|
235
235
|
protected getInitialRouterSearch(): string | undefined;
|
|
236
236
|
```
|
|
237
237
|
|
|
238
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
238
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:185](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L185)
|
|
239
239
|
|
|
240
240
|
Return the initial URL search string for query-param forwarding on `connect()`.
|
|
241
241
|
|
|
@@ -260,7 +260,7 @@ from the first `"?"`. Returns `undefined` when no query string is present so
|
|
|
260
260
|
protected navigateRouter(path): void;
|
|
261
261
|
```
|
|
262
262
|
|
|
263
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
263
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L91)
|
|
264
264
|
|
|
265
265
|
Navigate Vue Router to the given path.
|
|
266
266
|
|
|
@@ -296,7 +296,7 @@ so when the watcher fires with the same path it short-circuits at the
|
|
|
296
296
|
protected resolveNavigationPath(route): string | null;
|
|
297
297
|
```
|
|
298
298
|
|
|
299
|
-
Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
299
|
+
Defined in: [play-router/src/router-bridge-base.ts:395](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L395)
|
|
300
300
|
|
|
301
301
|
Resolve an actor route value to a concrete URL path for navigation.
|
|
302
302
|
|
|
@@ -335,7 +335,7 @@ Concrete URL path, or `null` if navigation should be skipped
|
|
|
335
335
|
protected syncActorFromRouter(pathname, search?): void;
|
|
336
336
|
```
|
|
337
337
|
|
|
338
|
-
Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
338
|
+
Defined in: [play-router/src/router-bridge-base.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L315)
|
|
339
339
|
|
|
340
340
|
Sync actor state when router location changes.
|
|
341
341
|
|
|
@@ -365,7 +365,7 @@ Prevents circular updates via isProcessingNavigation flag.
|
|
|
365
365
|
protected syncRouterFromActor(route): void;
|
|
366
366
|
```
|
|
367
367
|
|
|
368
|
-
Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
368
|
+
Defined in: [play-router/src/router-bridge-base.ts:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/router-bridge-base.ts#L290)
|
|
369
369
|
|
|
370
370
|
Sync router location when actor route signal changes.
|
|
371
371
|
|
|
@@ -402,7 +402,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
|
|
|
402
402
|
protected unwatchRouterChanges(): void;
|
|
403
403
|
```
|
|
404
404
|
|
|
405
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
405
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:168](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L168)
|
|
406
406
|
|
|
407
407
|
Stop watching for router location changes.
|
|
408
408
|
|
|
@@ -424,7 +424,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
|
|
|
424
424
|
protected watchRouterChanges(): void;
|
|
425
425
|
```
|
|
426
426
|
|
|
427
|
-
Defined in: [play-vue-router/src/vue-router-bridge.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
427
|
+
Defined in: [play-vue-router/src/vue-router-bridge.ts:118](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-vue-router/src/vue-router-bridge.ts#L118)
|
|
428
428
|
|
|
429
429
|
Subscribe to Vue Router changes using `watch` from `@vue/reactivity`.
|
|
430
430
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-vue-router](../README.md) / createRouteMap
|
|
2
2
|
|
|
3
3
|
# Function: createRouteMap()
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
function createRouteMap(machine, options?): RouteMap;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.
|
|
9
|
+
Defined in: [play-router/src/create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.46/packages/play-router/src/create-route-map.ts#L45)
|
|
10
10
|
|
|
11
11
|
Create a `RouteMap` from an XState state machine.
|
|
12
12
|
|