@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/api/@xmachines/play/classes/NonNullableError.md +7 -7
- package/api/@xmachines/play/classes/PlayError.md +7 -7
- package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
- package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/README.md +2 -0
- package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
- package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
- package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
- package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
- package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
- package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
- package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
- package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
- package/api/@xmachines/play-dom/README.md +2 -0
- package/api/@xmachines/play-dom/classes/PlayRenderer.md +28 -4
- package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
- package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
- package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-dom/functions/renderSpec.md +12 -30
- package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
- package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
- package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
- package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
- package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
- package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
- package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
- package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +28 -0
- package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
- package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
- package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
- package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
- package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
- package/api/@xmachines/play-dom/variables/schema.md +1 -1
- package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
- package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
- package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
- package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
- package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-react/README.md +6 -6
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
- 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 +1 -1
- package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
- package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
- package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
- package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
- package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
- 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 +4 -4
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
- package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
- 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 +5 -5
- package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
- package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
- package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-react-router/README.md +10 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +45 -32
- package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
- package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
- package/api/@xmachines/play-router/README.md +6 -8
- package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +50 -37
- package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
- package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
- package/api/@xmachines/play-router/functions/extractRouteParams.md +9 -1
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +7 -2
- package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
- package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
- package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
- package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
- package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
- package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -2
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
- package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
- package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
- package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +8 -8
- 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 +8 -8
- 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 +5 -5
- package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
- 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/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 +1 -1
- package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
- package/api/@xmachines/play-solid-router/README.md +7 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +40 -33
- package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
- package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
- package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-solid-router/{functions → variables}/PlayRouterProvider.md +6 -6
- package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
- package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
- package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
- package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
- 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 +6 -6
- package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
- package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
- 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/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.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/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
- package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +69 -52
- package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
- package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
- package/api/@xmachines/play-tanstack-router/README.md +58 -0
- package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +511 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
- package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
- package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +106 -79
- package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +30 -7
- package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
- package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
- package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
- package/api/@xmachines/play-vue/functions/useActor.md +1 -1
- 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 +5 -5
- 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 +8 -8
- 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 +5 -5
- package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
- package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.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 +1 -1
- 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/classes/RouteMap.md +17 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +74 -63
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
- package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -6
- package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +6 -6
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +72 -169
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/shared/vite-aliases/README.md +1 -0
- package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
- package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
- package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
- package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
- package/api/@xmachines/shared/vitest/README.md +5 -0
- package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
- package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
- package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
- package/api/README.md +1 -0
- package/api/llms.txt +4 -3
- package/contributing/architecture.md +74 -74
- package/contributing/configuration.md +2 -17
- package/contributing/deployment.md +8 -8
- package/contributing/development.md +2 -2
- package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
- package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
- package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
- package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
- package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
- package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
- package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
- package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
- package/guides/README.md +6 -44
- package/guides/getting-started.md +37 -37
- package/package.json +6 -3
- package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
- package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
|
@@ -302,6 +302,7 @@ MIT — see [LICENSE](LICENSE).
|
|
|
302
302
|
|
|
303
303
|
- [PlayActor](interfaces/PlayActor.md)
|
|
304
304
|
- [PlayRouteEvent](interfaces/PlayRouteEvent.md)
|
|
305
|
+
- [PlayRouterProviderBaseProps](interfaces/PlayRouterProviderBaseProps.md)
|
|
305
306
|
- [PlayRouterProviderProps](interfaces/PlayRouterProviderProps.md)
|
|
306
307
|
- [RouteMapOptions](interfaces/RouteMapOptions.md)
|
|
307
308
|
- [RouteMapping](interfaces/RouteMapping.md)
|
|
@@ -309,11 +310,16 @@ MIT — see [LICENSE](LICENSE).
|
|
|
309
310
|
|
|
310
311
|
## Type Aliases
|
|
311
312
|
|
|
313
|
+
- [PlayRouterBridgeConstructor](type-aliases/PlayRouterBridgeConstructor.md)
|
|
312
314
|
- [~~RoutableActor~~](type-aliases/RoutableActor.md)
|
|
313
315
|
- [TanStackRouterInstance](type-aliases/TanStackRouterInstance.md)
|
|
314
316
|
- [TanStackRouterLike](type-aliases/TanStackRouterLike.md)
|
|
315
317
|
|
|
318
|
+
## Variables
|
|
319
|
+
|
|
320
|
+
- [PlayRouterProvider](variables/PlayRouterProvider.md)
|
|
321
|
+
|
|
316
322
|
## Functions
|
|
317
323
|
|
|
324
|
+
- [createPlayRouterProvider](functions/createPlayRouterProvider.md)
|
|
318
325
|
- [createRouteMap](functions/createRouteMap.md)
|
|
319
|
-
- [PlayRouterProvider](functions/PlayRouterProvider.md)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: RouteMap
|
|
4
4
|
|
|
5
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
5
|
+
Defined in: [play-router/src/base-route-map.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L101)
|
|
6
6
|
|
|
7
7
|
Shared bidirectional route map base class.
|
|
8
8
|
|
|
@@ -17,10 +17,17 @@ own and inherit the full public API from here.
|
|
|
17
17
|
- Results are cached after the first match in an LRU cache (default 500 entries,
|
|
18
18
|
configurable via the `cacheSize` constructor option)
|
|
19
19
|
|
|
20
|
-
**Pattern syntax** (`:param` / `:param?`):
|
|
20
|
+
**Pattern syntax** (`:param` / `:param?` / `*`):
|
|
21
21
|
|
|
22
22
|
- `:param` — required segment, matches exactly one non-`/` segment
|
|
23
23
|
- `:param?` — optional segment, matches zero or one non-`/` segment
|
|
24
|
+
- `*` — wildcard, matches any number of segments (URLPattern semantics)
|
|
25
|
+
|
|
26
|
+
**StateId forms:** stateIds may be registered and looked up in either
|
|
27
|
+
`"#stateId"` or `"stateId"` form — `RouteMap` canonicalizes internally.
|
|
28
|
+
`getStateIdByPath` returns the stateId exactly as registered;
|
|
29
|
+
`getPathByStateId` accepts both forms. Registering the same stateId in both
|
|
30
|
+
forms refers to one entry (the later registration wins for reverse lookup).
|
|
24
31
|
|
|
25
32
|
## Example
|
|
26
33
|
|
|
@@ -50,7 +57,7 @@ map.getPathByStateId("missing"); // null
|
|
|
50
57
|
new RouteMap(mappings, options?): RouteMap;
|
|
51
58
|
```
|
|
52
59
|
|
|
53
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
60
|
+
Defined in: [play-router/src/base-route-map.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L127)
|
|
54
61
|
|
|
55
62
|
Build a route map from an array of state ID ↔ path mappings.
|
|
56
63
|
|
|
@@ -78,10 +85,14 @@ buckets for efficient candidate selection.
|
|
|
78
85
|
getPathByStateId(stateId): string | null;
|
|
79
86
|
```
|
|
80
87
|
|
|
81
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
88
|
+
Defined in: [play-router/src/base-route-map.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L218)
|
|
82
89
|
|
|
83
90
|
Look up the path pattern registered for a state ID.
|
|
84
91
|
|
|
92
|
+
Accepts the stateId in either `"#stateId"` or `"stateId"` form regardless of
|
|
93
|
+
which form was used at registration — lookups are canonicalized internally,
|
|
94
|
+
so consumers never need to try both forms.
|
|
95
|
+
|
|
85
96
|
#### Parameters
|
|
86
97
|
|
|
87
98
|
| Parameter | Type | Description |
|
|
@@ -98,6 +109,7 @@ The registered path pattern, or `null` if the state ID is unknown
|
|
|
98
109
|
|
|
99
110
|
```typescript
|
|
100
111
|
map.getPathByStateId("profile"); // "/profile/:userId"
|
|
112
|
+
map.getPathByStateId("#profile"); // "/profile/:userId" (same entry)
|
|
101
113
|
map.getPathByStateId("missing"); // null
|
|
102
114
|
```
|
|
103
115
|
|
|
@@ -109,7 +121,7 @@ map.getPathByStateId("missing"); // null
|
|
|
109
121
|
getStateIdByPath(path): string | null;
|
|
110
122
|
```
|
|
111
123
|
|
|
112
|
-
Defined in: [play-router/src/base-route-map.ts:
|
|
124
|
+
Defined in: [play-router/src/base-route-map.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L178)
|
|
113
125
|
|
|
114
126
|
Resolve a URL path to its mapped state ID.
|
|
115
127
|
|
|
@@ -2,17 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: TanStackSolidRouterBridge
|
|
4
4
|
|
|
5
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:
|
|
5
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L42)
|
|
6
6
|
|
|
7
|
-
TanStack Solid Router
|
|
7
|
+
TanStack Solid Router adapter implementing RouterBridge protocol via TanStackRouterBridgeBase
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
## Remarks
|
|
10
|
+
|
|
11
|
+
All behavior lives in the shared `TanStackRouterBridgeBase` (see its docs for the
|
|
12
|
+
history-subscription rationale and initial-sync semantics). This subclass binds the
|
|
13
|
+
adapter to the Solid flavour of TanStack Router and keeps the `dispose()` alias.
|
|
14
|
+
|
|
15
|
+
Consumers should call `onCleanup(() => bridge.disconnect())` in their Solid
|
|
16
|
+
component to ensure the bridge disconnects on unmount.
|
|
12
17
|
|
|
13
18
|
## Extends
|
|
14
19
|
|
|
15
|
-
- [`
|
|
20
|
+
- [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md)
|
|
16
21
|
|
|
17
22
|
## Constructors
|
|
18
23
|
|
|
@@ -25,39 +30,40 @@ new TanStackSolidRouterBridge(
|
|
|
25
30
|
routeMap): TanStackSolidRouterBridge;
|
|
26
31
|
```
|
|
27
32
|
|
|
28
|
-
Defined in: [play-tanstack-
|
|
33
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
|
|
29
34
|
|
|
30
|
-
Create a TanStack
|
|
35
|
+
Create a TanStack Router bridge
|
|
31
36
|
|
|
32
37
|
#### Parameters
|
|
33
38
|
|
|
34
|
-
| Parameter | Type
|
|
35
|
-
| ---------- |
|
|
36
|
-
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)
|
|
37
|
-
| `actor` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
|
|
38
|
-
| `routeMap` | [`
|
|
39
|
+
| Parameter | Type | Description |
|
|
40
|
+
| ---------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
41
|
+
| `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | TanStack Router instance (from `createRouter`) |
|
|
42
|
+
| `actor` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | XMachines actor instance |
|
|
43
|
+
| `routeMap` | [`TanStackRouteMapLike`](../../play-tanstack-router/type-aliases/TanStackRouteMapLike.md) | Bidirectional mapping between state IDs and paths |
|
|
39
44
|
|
|
40
45
|
#### Returns
|
|
41
46
|
|
|
42
47
|
`TanStackSolidRouterBridge`
|
|
43
48
|
|
|
44
|
-
####
|
|
49
|
+
#### Inherited from
|
|
45
50
|
|
|
46
|
-
[`
|
|
51
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`constructor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#constructor)
|
|
47
52
|
|
|
48
53
|
## Properties
|
|
49
54
|
|
|
50
|
-
| Property | Modifier | Type | Default value | Description | Inherited from
|
|
51
|
-
| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
52
|
-
| <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | `undefined` | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`
|
|
53
|
-
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`
|
|
54
|
-
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`
|
|
55
|
-
| <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`. | [`
|
|
56
|
-
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`
|
|
57
|
-
| <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.
|
|
58
|
-
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | -
|
|
59
|
-
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | -
|
|
60
|
-
| <a id="property-
|
|
55
|
+
| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
|
|
56
|
+
| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
57
|
+
| <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | `undefined` | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`actor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L124) |
|
|
58
|
+
| <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`hasConnectedOnce`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L99) |
|
|
59
|
+
| <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`isConnected`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L98) |
|
|
60
|
+
| <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`. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`isProcessingNavigation`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L111) |
|
|
61
|
+
| <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`lastSyncedPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L100) |
|
|
62
|
+
| <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. `getPathByStateId` may be keyed on either the `"#stateId"` or the bare `"stateId"` form — both forms are tried automatically by the bridge, so custom implementations (e.g. plain test objects) need only handle one. | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`routeMap`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L125) |
|
|
63
|
+
| `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L127) |
|
|
64
|
+
| `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L126) |
|
|
65
|
+
| <a id="property-router"></a> `router` | `readonly` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | `undefined` | TanStack Router instance (from `createRouter`) | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`router`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-router) | [play-tanstack-router/src/tanstack-router-bridge-base.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L113) |
|
|
66
|
+
| <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`routeWatcher`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L112) |
|
|
61
67
|
|
|
62
68
|
## Methods
|
|
63
69
|
|
|
@@ -67,7 +73,7 @@ Create a TanStack Solid Router bridge.
|
|
|
67
73
|
connect(): void;
|
|
68
74
|
```
|
|
69
75
|
|
|
70
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
76
|
+
Defined in: [play-router/src/router-bridge-base.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L151)
|
|
71
77
|
|
|
72
78
|
Connect the router bridge to the Actor.
|
|
73
79
|
|
|
@@ -89,7 +95,7 @@ Adapters that need custom initial-sync behavior should override
|
|
|
89
95
|
|
|
90
96
|
#### Inherited from
|
|
91
97
|
|
|
92
|
-
[`
|
|
98
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`connect`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#connect)
|
|
93
99
|
|
|
94
100
|
---
|
|
95
101
|
|
|
@@ -99,7 +105,7 @@ Adapters that need custom initial-sync behavior should override
|
|
|
99
105
|
disconnect(): void;
|
|
100
106
|
```
|
|
101
107
|
|
|
102
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
108
|
+
Defined in: [play-router/src/router-bridge-base.ts:256](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L256)
|
|
103
109
|
|
|
104
110
|
Disconnect the router bridge from the Actor.
|
|
105
111
|
|
|
@@ -111,7 +117,7 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
111
117
|
|
|
112
118
|
#### Inherited from
|
|
113
119
|
|
|
114
|
-
[`
|
|
120
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`disconnect`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#disconnect)
|
|
115
121
|
|
|
116
122
|
---
|
|
117
123
|
|
|
@@ -121,7 +127,7 @@ Stops signal watching and unregisters framework-specific router listener.
|
|
|
121
127
|
dispose(): void;
|
|
122
128
|
```
|
|
123
129
|
|
|
124
|
-
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:
|
|
130
|
+
Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L46)
|
|
125
131
|
|
|
126
132
|
Dispose the bridge (alias for disconnect).
|
|
127
133
|
|
|
@@ -137,7 +143,7 @@ Dispose the bridge (alias for disconnect).
|
|
|
137
143
|
protected extractParams(pathname, stateId): Record<string, string>;
|
|
138
144
|
```
|
|
139
145
|
|
|
140
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
146
|
+
Defined in: [play-router/src/router-bridge-base.ts:423](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L423)
|
|
141
147
|
|
|
142
148
|
Extract path parameters from URL using the URLPattern API.
|
|
143
149
|
|
|
@@ -165,7 +171,7 @@ When URLPattern is absent and the route is parameterized
|
|
|
165
171
|
|
|
166
172
|
#### Inherited from
|
|
167
173
|
|
|
168
|
-
[`
|
|
174
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`extractParams`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#extractparams)
|
|
169
175
|
|
|
170
176
|
---
|
|
171
177
|
|
|
@@ -175,7 +181,7 @@ When URLPattern is absent and the route is parameterized
|
|
|
175
181
|
protected extractQuery(search): Record<string, string>;
|
|
176
182
|
```
|
|
177
183
|
|
|
178
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
184
|
+
Defined in: [play-router/src/router-bridge-base.ts:480](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L480)
|
|
179
185
|
|
|
180
186
|
Extract query parameters from URL search string.
|
|
181
187
|
|
|
@@ -193,7 +199,7 @@ Extracted query parameters or empty object
|
|
|
193
199
|
|
|
194
200
|
#### Inherited from
|
|
195
201
|
|
|
196
|
-
[`
|
|
202
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`extractQuery`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#extractquery)
|
|
197
203
|
|
|
198
204
|
---
|
|
199
205
|
|
|
@@ -203,21 +209,32 @@ Extracted query parameters or empty object
|
|
|
203
209
|
protected getInitialRouterPath(): string | null;
|
|
204
210
|
```
|
|
205
211
|
|
|
206
|
-
Defined in: [play-tanstack-
|
|
212
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L153)
|
|
207
213
|
|
|
208
|
-
|
|
214
|
+
Read the router's current pathname for initial sync.
|
|
209
215
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
216
|
+
Called once in connect() to handle cold-load / deep-link scenarios where
|
|
217
|
+
the URL differs from the actor's initial state (e.g. user pastes /dashboard
|
|
218
|
+
while logged out — the actor must be redirected to /login before rendering).
|
|
219
|
+
|
|
220
|
+
Uses `router.history.location.pathname` — reflects `window.location` immediately,
|
|
221
|
+
before the router has been loaded or a `<RouterProvider>` mounted.
|
|
222
|
+
`router.state.location` is only populated after `router.load()` which may not
|
|
223
|
+
have run yet when the bridge first connects in a component effect.
|
|
224
|
+
|
|
225
|
+
The base class `connect()` uses `actor.initialRoute` to distinguish:
|
|
226
|
+
|
|
227
|
+
- **Deep-link:** router URL differs from machine's initial route → router wins.
|
|
228
|
+
- **Restore:** router at machine's initial route, actor at a different restored
|
|
229
|
+
route → actor wins, bridge pushes actor's restored route to the router.
|
|
213
230
|
|
|
214
231
|
#### Returns
|
|
215
232
|
|
|
216
233
|
`string` \| `null`
|
|
217
234
|
|
|
218
|
-
####
|
|
235
|
+
#### Inherited from
|
|
219
236
|
|
|
220
|
-
[`
|
|
237
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`getInitialRouterPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#getinitialrouterpath)
|
|
221
238
|
|
|
222
239
|
---
|
|
223
240
|
|
|
@@ -227,19 +244,22 @@ used by `TanStackReactRouterBridge`.
|
|
|
227
244
|
protected getInitialRouterSearch(): string | undefined;
|
|
228
245
|
```
|
|
229
246
|
|
|
230
|
-
Defined in: [play-tanstack-
|
|
247
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L169)
|
|
231
248
|
|
|
232
249
|
Return the initial URL search string for query-param forwarding on `connect()`.
|
|
233
250
|
|
|
234
|
-
Reads `router.history.location.search` — same source
|
|
251
|
+
Reads `router.history.location.search` — the same source used by
|
|
252
|
+
`getInitialRouterPath()`, which reflects `window.location` immediately before
|
|
253
|
+
`router.load()` or `<RouterProvider>` mounts. An empty string returns `undefined`
|
|
254
|
+
so `syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
|
|
235
255
|
|
|
236
256
|
#### Returns
|
|
237
257
|
|
|
238
258
|
`string` \| `undefined`
|
|
239
259
|
|
|
240
|
-
####
|
|
260
|
+
#### Inherited from
|
|
241
261
|
|
|
242
|
-
[`
|
|
262
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`getInitialRouterSearch`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#getinitialroutersearch)
|
|
243
263
|
|
|
244
264
|
---
|
|
245
265
|
|
|
@@ -249,9 +269,13 @@ Reads `router.history.location.search` — same source as `getInitialRouterPath(
|
|
|
249
269
|
protected navigateRouter(path): void;
|
|
250
270
|
```
|
|
251
271
|
|
|
252
|
-
Defined in: [play-tanstack-
|
|
272
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L131)
|
|
273
|
+
|
|
274
|
+
Navigate TanStack Router to the given path.
|
|
253
275
|
|
|
254
|
-
|
|
276
|
+
Calls `router.load()` (fire-and-forget) after `navigate` so TanStack re-runs
|
|
277
|
+
route matching and loaders — `navigate` alone does not when no
|
|
278
|
+
`<RouterProvider>` (Transitioner) is mounted.
|
|
255
279
|
|
|
256
280
|
#### Parameters
|
|
257
281
|
|
|
@@ -263,9 +287,9 @@ Navigate TanStack Solid Router to the given path.
|
|
|
263
287
|
|
|
264
288
|
`void`
|
|
265
289
|
|
|
266
|
-
####
|
|
290
|
+
#### Inherited from
|
|
267
291
|
|
|
268
|
-
[`
|
|
292
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`navigateRouter`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#navigaterouter)
|
|
269
293
|
|
|
270
294
|
---
|
|
271
295
|
|
|
@@ -275,7 +299,7 @@ Navigate TanStack Solid Router to the given path.
|
|
|
275
299
|
protected resolveNavigationPath(route): string | null;
|
|
276
300
|
```
|
|
277
301
|
|
|
278
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
302
|
+
Defined in: [play-router/src/router-bridge-base.ts:447](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L447)
|
|
279
303
|
|
|
280
304
|
Resolve an actor route value to a concrete URL path for navigation.
|
|
281
305
|
|
|
@@ -284,11 +308,13 @@ can call this to normalize stateIds (with or without `#` prefix) to paths.
|
|
|
284
308
|
Returns `null` when navigation is not possible:
|
|
285
309
|
|
|
286
310
|
- unknown stateId with no route map entry
|
|
287
|
-
- parameterized pattern (e.g. `/profile/:id
|
|
311
|
+
- parameterized or wildcard pattern (e.g. `/profile/:id`, `/docs/*`) — no
|
|
312
|
+
concrete values available to build a real URL
|
|
288
313
|
- non-path string that isn't a known stateId
|
|
289
314
|
|
|
290
|
-
|
|
291
|
-
|
|
315
|
+
StateId lookups try both the `"#stateId"` and bare `"stateId"` forms
|
|
316
|
+
automatically (via `lookupPathByStateId`), so custom route maps keyed on
|
|
317
|
+
only one form still resolve.
|
|
292
318
|
|
|
293
319
|
#### Parameters
|
|
294
320
|
|
|
@@ -304,7 +330,7 @@ Concrete URL path, or `null` if navigation should be skipped
|
|
|
304
330
|
|
|
305
331
|
#### Inherited from
|
|
306
332
|
|
|
307
|
-
[`
|
|
333
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`resolveNavigationPath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#resolvenavigationpath)
|
|
308
334
|
|
|
309
335
|
---
|
|
310
336
|
|
|
@@ -314,7 +340,7 @@ Concrete URL path, or `null` if navigation should be skipped
|
|
|
314
340
|
protected sanitizePath(pathname): string | null;
|
|
315
341
|
```
|
|
316
342
|
|
|
317
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
343
|
+
Defined in: [play-router/src/router-bridge-base.ts:513](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L513)
|
|
318
344
|
|
|
319
345
|
Sanitize and validate a raw URL pathname received from the router.
|
|
320
346
|
|
|
@@ -342,7 +368,7 @@ Sanitized pathname, or `null` if the path is invalid / too long.
|
|
|
342
368
|
|
|
343
369
|
#### Inherited from
|
|
344
370
|
|
|
345
|
-
[`
|
|
371
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`sanitizePath`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#sanitizepath)
|
|
346
372
|
|
|
347
373
|
---
|
|
348
374
|
|
|
@@ -352,7 +378,7 @@ Sanitized pathname, or `null` if the path is invalid / too long.
|
|
|
352
378
|
protected syncActorFromRouter(pathname, search?): void;
|
|
353
379
|
```
|
|
354
380
|
|
|
355
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
381
|
+
Defined in: [play-router/src/router-bridge-base.ts:347](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L347)
|
|
356
382
|
|
|
357
383
|
Sync actor state when router location changes.
|
|
358
384
|
|
|
@@ -382,7 +408,7 @@ sends no spurious event.
|
|
|
382
408
|
|
|
383
409
|
#### Inherited from
|
|
384
410
|
|
|
385
|
-
[`
|
|
411
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`syncActorFromRouter`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#syncactorfromrouter)
|
|
386
412
|
|
|
387
413
|
---
|
|
388
414
|
|
|
@@ -392,17 +418,22 @@ sends no spurious event.
|
|
|
392
418
|
protected syncRouterFromActor(route): void;
|
|
393
419
|
```
|
|
394
420
|
|
|
395
|
-
Defined in: [play-router/src/router-bridge-base.ts:
|
|
421
|
+
Defined in: [play-router/src/router-bridge-base.ts:302](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/router-bridge-base.ts#L302)
|
|
396
422
|
|
|
397
423
|
Sync router location when actor route signal changes.
|
|
398
424
|
|
|
399
|
-
|
|
425
|
+
Resolves the actor route to a concrete URL path and calls navigateRouter()
|
|
426
|
+
for framework-specific navigation. When the route cannot be resolved
|
|
427
|
+
(unknown stateId, parameterized pattern with no concrete values) the push
|
|
428
|
+
is skipped entirely — `navigateRouter` is never called with a raw stateId
|
|
429
|
+
or pattern.
|
|
400
430
|
|
|
401
431
|
Echo suppression — preventing the router's own callback from re-driving the
|
|
402
|
-
actor — is handled entirely by `lastSyncedPath`: it is set to
|
|
403
|
-
`navigateRouter()` is called, so any `syncActorFromRouter`
|
|
404
|
-
same path short-circuits at the
|
|
405
|
-
|
|
432
|
+
actor — is handled entirely by `lastSyncedPath`: it is set to the resolved
|
|
433
|
+
path before `navigateRouter()` is called, so any `syncActorFromRouter`
|
|
434
|
+
invocation for the same path short-circuits at the
|
|
435
|
+
`sanitized === lastSyncedPath` check and sends no event regardless of
|
|
436
|
+
whether the callback fires synchronously or asynchronously.
|
|
406
437
|
|
|
407
438
|
`isProcessingNavigation` is NOT set here — it is only used inside
|
|
408
439
|
`syncActorFromRouter` to guard against re-entrant guard-redirect loops.
|
|
@@ -419,7 +450,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
|
|
|
419
450
|
|
|
420
451
|
#### Inherited from
|
|
421
452
|
|
|
422
|
-
[`
|
|
453
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`syncRouterFromActor`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#syncrouterfromactor)
|
|
423
454
|
|
|
424
455
|
---
|
|
425
456
|
|
|
@@ -429,7 +460,7 @@ no event regardless of whether the callback fires synchronously or asynchronousl
|
|
|
429
460
|
protected unwatchRouterChanges(): void;
|
|
430
461
|
```
|
|
431
462
|
|
|
432
|
-
Defined in: [play-tanstack-
|
|
463
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:196](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L196)
|
|
433
464
|
|
|
434
465
|
Stop watching TanStack Router changes.
|
|
435
466
|
|
|
@@ -437,9 +468,9 @@ Stop watching TanStack Router changes.
|
|
|
437
468
|
|
|
438
469
|
`void`
|
|
439
470
|
|
|
440
|
-
####
|
|
471
|
+
#### Inherited from
|
|
441
472
|
|
|
442
|
-
[`
|
|
473
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`unwatchRouterChanges`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#unwatchrouterchanges)
|
|
443
474
|
|
|
444
475
|
---
|
|
445
476
|
|
|
@@ -449,7 +480,7 @@ Stop watching TanStack Router changes.
|
|
|
449
480
|
protected watchRouterChanges(): void;
|
|
450
481
|
```
|
|
451
482
|
|
|
452
|
-
Defined in: [play-tanstack-
|
|
483
|
+
Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L184)
|
|
453
484
|
|
|
454
485
|
Subscribe to ALL navigation events via router.history.
|
|
455
486
|
|
|
@@ -457,18 +488,14 @@ router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
|
|
|
457
488
|
covering both link clicks and browser back/forward button presses.
|
|
458
489
|
|
|
459
490
|
The subscriber callback receives { location, action } where location is the
|
|
460
|
-
new history location with pathname and search already updated.
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
back/forward works regardless of whether <RouterProvider> is mounted.
|
|
464
|
-
|
|
465
|
-
Consumers should call `onCleanup(() => bridge.disconnect())` in their Solid
|
|
466
|
-
component to ensure the bridge disconnects on unmount.
|
|
491
|
+
new history location with pathname and search already updated. It calls
|
|
492
|
+
`router.load()` (fire-and-forget) so TanStack re-runs matching/loaders for the
|
|
493
|
+
new location, mirroring what Transitioner does when `<RouterProvider>` is mounted.
|
|
467
494
|
|
|
468
495
|
#### Returns
|
|
469
496
|
|
|
470
497
|
`void`
|
|
471
498
|
|
|
472
|
-
####
|
|
499
|
+
#### Inherited from
|
|
473
500
|
|
|
474
|
-
[`
|
|
501
|
+
[`TanStackRouterBridgeBase`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md).[`watchRouterChanges`](../../play-tanstack-router/classes/TanStackRouterBridgeBase.md#watchrouterchanges)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
[API](../../../README.md) / [@xmachines/play-tanstack-solid-router](../README.md) / createPlayRouterProvider
|
|
2
|
+
|
|
3
|
+
# Function: createPlayRouterProvider()
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
function createPlayRouterProvider<TRouter>(BridgeCtor): <TActor>(props) => any;
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Defined in: [play-tanstack-solid-router/src/create-play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-solid-router/src/create-play-router-provider.tsx#L76)
|
|
10
|
+
|
|
11
|
+
Create a Solid `PlayRouterProvider` component bound to a specific bridge class.
|
|
12
|
+
|
|
13
|
+
The returned component connects a `PlayerActor` to the framework router,
|
|
14
|
+
keeping actor state and browser URL in sync bidirectionally.
|
|
15
|
+
|
|
16
|
+
The bridge is created synchronously at component evaluation time (Solid's
|
|
17
|
+
execution model) and torn down via `onCleanup` when the component is disposed.
|
|
18
|
+
Unlike React, prop stability is not a concern — Solid's `props` accessor is
|
|
19
|
+
already reactive and the bridge is created once per component instance.
|
|
20
|
+
|
|
21
|
+
## Type Parameters
|
|
22
|
+
|
|
23
|
+
| Type Parameter |
|
|
24
|
+
| -------------- |
|
|
25
|
+
| `TRouter` |
|
|
26
|
+
|
|
27
|
+
## Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type | Description |
|
|
30
|
+
| ------------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
31
|
+
| `BridgeCtor` | [`PlayRouterBridgeConstructor`](../type-aliases/PlayRouterBridgeConstructor.md)\<`TRouter`\> | Bridge class constructed as `new BridgeCtor(router, actor, routeMap)`. |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
A `PlayRouterProvider` component, generic over the actor type so the
|
|
36
|
+
`renderer` callback receives the same concrete actor type that was passed in.
|
|
37
|
+
|
|
38
|
+
\<`TActor`\>(`props`) => `any`
|
|
39
|
+
|
|
40
|
+
## Example
|
|
41
|
+
|
|
42
|
+
```tsx
|
|
43
|
+
export const PlayRouterProvider = createPlayRouterProvider(TanStackSolidRouterBridge);
|
|
44
|
+
```
|
|
@@ -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.54/packages/play-router/src/create-route-map.ts#L45)
|
|
10
10
|
|
|
11
11
|
Create a `RouteMap` from an XState state machine.
|
|
12
12
|
|