Skip to content
XMachines
Search
Ctrl
K
Cancel
GitLab
Select theme
Dark
Light
Auto
Select language
English
Menu
Docs
Blog
Select documentation version
7.0.0 (latest)
6.1.0
6.0.0
5.0.2
4.0.0
3.0.0
Guides
Overview
Getting Started
Understanding State Machines in XMachines
Understanding the Actor Model and the Actor/Infrastructure Split
Inspecting a Running Actor
Understanding Routing in XMachines
Understanding TC39 Signals in XMachines
Platform
Overview
Play
Browser
Planned
Node
Planned
Examples
Browse Examples
Basic State Machine
Form Validation with Typed Context
Multi-Router Integration
Routing Patterns
Traffic Light State Machine
play-dom
@xmachines/play-dom-demo
Function: createNavBar()
Function: initShell()
Variable: About
Variable: authCatalog
Variable: Contact
Variable: Dashboard
Variable: Home
Variable: Login
Variable: NavBarView
Variable: Navigation
Variable: Overview
Variable: Profile
Variable: Settings
Variable: Stats
Type Alias: AuthCatalog
play-dom-router
@xmachines/play-dom-router-demo
play-react
@xmachines/play-react-demo
Function: App()
Function: DebugPanel()
Function: HeaderNav()
Function: Shell()
Variable: About
Variable: authCatalog
Variable: Contact
Variable: Dashboard
Variable: DebugPanel
Variable: Home
Variable: Login
Variable: NavBar
Variable: NavBarView
Variable: Navigation
Variable: Overview
Variable: Profile
Variable: Settings
Variable: Shell
Variable: Stats
Type Alias: AuthCatalog
play-react-router
@xmachines/play-react-router-demo
play-solid
@xmachines/play-solid-demo
Function: App()
Function: DebugPanel()
Function: HeaderNav()
Function: Shell()
Variable: About
Variable: authCatalog
Variable: Contact
Variable: Dashboard
Variable: DebugPanel
Variable: Home
Variable: Login
Variable: NavBar
Variable: NavBarView
Variable: Navigation
Variable: Overview
Variable: Profile
Variable: Settings
Variable: Shell
Variable: Stats
Type Alias: AuthCatalog
play-solid-router
@xmachines/play-solid-router-demo
play-svelte
@xmachines/play-svelte-demo
Variable: App
Variable: authCatalog
Type Alias: App
Type Alias: AuthCatalog
play-svelte-spa-router
@xmachines/play-svelte-spa-router-demo
play-sveltekit-router
@xmachines/play-sveltekit-router-demo
play-tanstack-react-router
@xmachines/play-tanstack-react-router-demo
play-tanstack-solid-router
@xmachines/play-tanstack-solid-router-demo
play-vue
@xmachines/play-vue-demo
Variable: App
Variable: authCatalog
Type Alias: AuthCatalog
play-vue-router
@xmachines/play-vue-router-demo
API
API Reference
play
@xmachines/play
Function: asCleanup()
Function: assertNonNullable()
Type Alias: Cleanup
Variable: DISPOSE
Type Alias: DisposeKey
errors
index
Class: NonNullableError
Class: PlayError
Type Alias: PlayEvent<TPayload>
Function: shallowEqualExcept()
play-actor
@xmachines/play-actor
Interface: ActorEvent
Interface: PlayActor<TSnapshot, TEvent>
play-dom
@xmachines/play-dom
Type Alias: ActionFn<C, K>
Type Alias: Actions<C>
Function: asCleanup()
Type Alias: BaseComponentProps<P>
Type Alias: CatalogHasActions<C>
Type Alias: Cleanup
Interface: ComponentContext<C, K>
Type Alias: ComponentFn<C, K>
Type Alias: ComponentRegistry<C>
Type Alias: ConfirmHandler
Function: createPlayUI()
Interface: CreatePlayUIOptions
Function: createRenderer()
Function: createValidationRegistry()
Function: defineRegistry()
Type Alias: DefineRegistryOptions<C>
Interface: DefineRegistryResult
Type Alias: DomComponentRenderer
Type Alias: DomRegistry
Interface: DomRenderContext
Type Alias: DomSchema
Interface: EventHandle
Interface: FieldValidationState
Type Alias: MountFn
Interface: MountOptions
Interface: PlayDomOptions
Class: PlayRenderer
Type Alias: RenderErrorHandler
Function: renderSpec()
Interface: RenderSpecOptions
Variable: schema
Type Alias: SetState
Interface: UIProviderOptions
Interface: ValidationRegistry
play-dom-router
@xmachines/play-dom-router
Function: asCleanup()
Interface: BasePathOptions
Interface: BrowserHistory
Interface: BrowserWindow
Type Alias: Cleanup
Function: connectRouter()
Interface: ConnectRouterOptions
Function: createBrowserHistory()
Function: createRouter()
Variable: DISPOSE
Class: DomRouterBridge
Interface: PlayRouteEvent
Interface: RoutableActor
Interface: RouteLookupContract
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Interface: RouterConnection()
Interface: VanillaRouter
play-react
@xmachines/play-react
Function: ActionProvider()
Interface: ActionProviderProps
Variable: ActorProvider
Interface: ActorProviderProps
Type Alias: AnyPlayActor
Interface: ComponentContext<C, K>
Type Alias: ComponentFn<C, K>
Function: defineRegistry()
Function: JSONUIProvider()
Interface: JSONUIProviderProps
Class: PlayErrorBoundary
Interface: PlayErrorBoundaryProps
Interface: PlayErrorBoundaryState
Variable: PlayRenderer
Variable: PlayUIProvider
Interface: PlayUIProviderProps
Function: Renderer()
Interface: RendererProps
Type Alias: RenderErrorHandler
Variable: schema
Function: StateProvider()
Interface: StateProviderProps
Function: useActor()
Function: useBoundProp()
Function: useFieldValidation()
Function: usePlayView()
Function: useSignalEffect()
Function: ValidationProvider()
Interface: ValidationProviderProps
Interface: ViewContextValue
Function: VisibilityProvider()
Interface: VisibilityProviderProps
play-react-router
@xmachines/play-react-router
Function: createPlayRouterProvider()
Function: createRouteMapFromTree()
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
Variable: PlayRouterProvider
Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Class: ReactRouterBridge
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
play-router
@xmachines/play-router
Interface: BasePathOptions
Function: buildPlayRouteEvent()
Interface: BuildPlayRouteEventOptions
Function: buildRouteTree()
Function: cleanFrameworkParams()
Function: createRouteMap()
Function: createRouteMapFromTree()
Function: createRouterConnection()
Function: detectDuplicateRoutes()
Variable: DISPOSE
Class: DuplicateBridgeError
Class: DuplicateRoutePathError
Class: EmptyRoutePathError
errors
Function: extractMachineRoutes()
Function: extractQuery()
Function: extractRouteParams()
Function: findRouteById()
Function: findRouteByPath()
Interface: FrameworkParamsSource
Function: getNavigableRoutes()
Function: getPatternParamNames()
Function: getRequiredPatternParamNames()
Function: getRoutableRoutes()
Function: getRouteMappings()
Function: getTransitionReachableRoutes()
index
Class: InvalidBasePathError
Class: InvalidRoutePatternError
Class: InvalidStateIdError
Function: isMountableBridge()
Function: isRouteReachable()
Function: joinBasePath()
Interface: LocationLike
Interface: MachineEdgeData
Type Alias: MachineGraph
Interface: MachineNodeData
Function: machineToGraph()
Class: MissingBasePathParamError
Interface: MountableRouterBridge
Function: mountKey()
Variable: NO_BASE_PATH
Function: normalizeBasePath()
Function: openProviderBridge()
Interface: OpenProviderBridgeArgs<TRouter, TActor>
Function: pickOwnParams()
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
Interface: PlayRouterProviderBaseProps<TRouter, TActor, TNode>
Function: repointProviderBridge()
Function: resolveBasePath()
Interface: ResolvedBasePath
Interface: ResolvedRoutePath
Function: resolveFrameworkParams()
Variable: ROOT_NODE_ID
Interface: Routable
Interface: RoutableActor
Type Alias: RouteData
Type Alias: RouteDataResolver
Function: routeExists()
Interface: RouteInfo
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouteMatch
Type Alias: RouteMetadata
Interface: RouteNode
Interface: RouteObject
Interface: RouterBridge
Abstract Class: RouterBridgeBase
Interface: RouterConnection()
Class: RouterSyncError
Interface: RouteTree<TGraph>
Interface: RouteWatcherHandle
Function: sanitizePathname()
Function: stripBasePath()
Class: UnknownStateTypeError
Function: validateRouteFormat()
Function: validateStateExists()
Interface: WindowLike
xstate
play-signals
@xmachines/play-signals
Type Alias: Cleanup
Class: Computed<T>
Interface: ComputedOptions<T>
Function: currentComputed()
Function: hasSinks()
Function: hasSources()
Function: introspectSinks()
Function: introspectSources()
Variable: isComputed
Variable: isState
Variable: isWatcher
Interface: Options<T>
Signal
Interface: SignalComputed<T>
Interface: SignalOptions<T>
Interface: SignalState<T>
Interface: SignalWatcher
Class: State<T>
subtle
Function: untrack()
Variable: unwatched
Variable: watched
Class: Watcher
Type Alias: WatcherNotify
Function: watchSignal()
play-solid
@xmachines/play-solid
Function: ActionProvider()
Interface: ActionProviderProps
Variable: ActorContext
Variable: ActorProvider
Interface: ActorProviderProps
Type Alias: AnyPlayActor
Interface: ComponentContext<C, K>
Type Alias: ComponentFn<C, K>
Type Alias: ComponentRegistry
Function: defineRegistry()
Interface: DefineRegistryResult
Function: JSONUIProvider()
Interface: JSONUIProviderProps
Variable: PlayRenderer
Variable: PlayUIProvider
Interface: PlayUIProviderProps
Function: Renderer()
Interface: RendererProps
Type Alias: RenderErrorHandler
Variable: schema
Type Alias: SetState
Function: StateProvider()
Interface: StateProviderProps
Function: useAction()
Function: useActions()
Function: useActor()
Function: useBoundProp()
Function: useFieldValidation()
Function: useIsVisible()
Function: useOptionalValidation()
Function: usePlayView()
Function: useStateBinding()
Function: useStateStore()
Function: useStateValue()
Function: useVisibility()
Function: ValidationProvider()
Interface: ValidationProviderProps
Interface: ViewContextValue
Function: VisibilityProvider()
Type Alias: VisibilityProviderProps
play-solid-router
@xmachines/play-solid-router
Function: createPlayRouterProvider()
Interface: PlayActor<TSnapshot, TEvent>
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
Variable: PlayRouterProvider
Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Class: SolidRouterBridge
Type Alias: SolidRouterHooks
play-svelte
@xmachines/play-svelte
Type Alias: ActionFn<C, K>
Type Alias: Actions<C>
Interface: ActorProviderProps
Type Alias: AnyPlayActor
Interface: BaseComponentProps<P>
Interface: ComponentContext<C, K>
Type Alias: ComponentFn<C, K>
Function: defineRegistry()
Interface: DefineRegistryOptions<C>
Function: getActorContext()
Function: getPlayViewContext()
Type Alias: JSONUIProviderProps
Type Alias: PlayRenderer
Variable: PlayRenderer
Interface: PlayUIProviderProps
Type Alias: RenderErrorHandler
Variable: schema
Function: setActorContext()
Type Alias: SetState
Interface: ViewContextValue
play-svelte-spa-router
@xmachines/play-svelte-spa-router
Interface: BasePathOptions
Function: connectRouter()
Interface: ConnectRouterOptions
Interface: PlayRouteEvent
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Interface: RouterConnection()
Class: SvelteSpaRouterBridge
Interface: WindowLike
play-sveltekit-router
@xmachines/play-sveltekit-router
Interface: BasePathOptions
Function: connectRouter()
Interface: ConnectRouterOptions
Interface: LocationLike
Interface: PlayRouteEvent
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Interface: RouterConnection()
Class: SvelteKitRouterBridge
play-tanstack-react-router
@xmachines/play-tanstack-react-router
Function: createPlayRouterProvider()
Function: createRouteMapFromTree()
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
Variable: PlayRouterProvider
Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Class: TanStackReactRouterBridge
Type Alias: TanStackRouterInstance
Type Alias: TanStackRouterLike
play-tanstack-router
@xmachines/play-tanstack-router
Type Alias: TanStackRouteMapLike
Class: TanStackRouterBridgeBase
Type Alias: TanStackRouterLike
play-tanstack-solid-router
@xmachines/play-tanstack-solid-router
Function: createPlayRouterProvider()
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter, TActor>
Variable: PlayRouterProvider
Type Alias: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Type Alias: TanStackRouterInstance
Type Alias: TanStackRouterLike
Class: TanStackSolidRouterBridge
play-url
@xmachines/play-url
Interface: BasePathOptions
Function: cleanFrameworkParams()
errors
Interface: FrameworkParamsSource
Function: getCandidates()
Function: getCompiledPattern()
Function: getIndexKey()
Function: getNormalizedParamNameMap()
Function: getPatternParamNames()
Function: getRequiredPatternParamNames()
Interface: GroupPart
Function: holdsUnsubstitutedParam()
index
Class: InvalidBasePathError
Class: InvalidRoutePatternError
Function: isParameterizedPattern()
Function: joinBasePath()
Interface: LiteralPart
Class: MissingBasePathParamError
Variable: NO_BASE_PATH
Function: normalizeBasePath()
Function: normalizeParamNames()
Interface: ParamPart
Interface: ParsedPattern
Function: parsePattern()
Type Alias: PatternModifier
Interface: PatternParam
Type Alias: PatternPart
Function: pickOwnParams()
Function: resolveBasePath()
Interface: ResolvedBasePath
Function: resolveFrameworkParams()
Function: stripBasePath()
Variable: URLPattern
Type Alias: URLPatternCtor
Type Alias: URLPatternLike
play-view
@xmachines/play-view
Function: attachRenderErrorHandler()
Interface: BaseActorProviderProps<TRegistry, TActor>
Interface: BaseViewContextValue<TRegistry>
Function: composePlayState()
Variable: CONTEXT_STATE_KEY
Function: createFailureLatch()
Function: createReportGuard()
Function: createViewStoreLifecycle()
errors
Interface: FailureLatch
Function: guardContextWrites()
index
Interface: PlaySpec
Class: ReadOnlyContextError
Function: refreshContextSubtree()
Interface: ReportGuard
Interface: ReportGuardMessages
Interface: ResolveViewStoreOptions
Function: reuseComposedState()
Function: sameViewInputs()
Function: toAtomState()
Function: typedSpec()
Interface: Viewable
Type Alias: ViewActor<TSnapshot, TEvent>
Interface: ViewInputs
Interface: ViewStoreLifecycle
Interface: ViewStoreResolution
play-vue
@xmachines/play-vue
Variable: ActionProvider
Interface: ActionProviderProps
Interface: ActorProviderProps
Type Alias: AnyPlayActor
Interface: ComponentContext<C, K>
Type Alias: ComponentEntry<C, K>
Type Alias: ComponentFn<C, K>
Type Alias: ComponentsMap<C>
Function: defineRegistry()
Type Alias: DefineRegistryOptions<C>
Interface: DefineRegistryResult
Variable: JSONUIProvider
Interface: JSONUIProviderProps
Variable: PlayRenderer
Interface: PlayUIProviderProps
Variable: Renderer
Interface: RendererProps
Type Alias: RenderErrorHandler
Variable: schema
Variable: StateProvider
Interface: StateProviderProps
Function: useActor()
Function: useBoundProp()
Function: useFieldValidation()
Function: usePlayView()
Variable: ValidationProvider
Interface: ValidationProviderProps
Interface: ViewContextValue
Variable: VisibilityProvider
play-vue-router
@xmachines/play-vue-router
errors
index
Interface: PlayRouteEvent
Variable: PlayRouterProvider
Interface: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Class: VueRouterBridge
Class: VueRouterNavigationError
Class: VueRouterSendError
play-xstate
@xmachines/play-xstate
Class: ActorThrewNonErrorError
Function: buildRouteUrl()
Type Alias: Capability<TMachine, TAdded>
Function: compose()
Function: definePlayer()
Function: deriveRoute()
Variable: DISPOSE
errors
Function: formatPlayRouteTransitions()
index
Class: InvalidEventError
Class: InvalidMachineError
Class: InvalidRouteHandlerError
Class: InvalidRouteMetadataError
Function: isAbsoluteRoute()
Class: MissingRouteParamError
Class: MissingStateIdError
Class: PlayerActor<TMachine>
Interface: PlayerConfig<TMachine, TCapabilities>
Type Alias: PlayerConstructor<TMachine, TCapabilities>
Type Alias: PlayerFactory<TMachine, TCapabilities>
Interface: PlayerFactoryResumeOptions<TMachine>
Interface: PlayerOptions<TMachine>
Interface: RouteContext
Type Alias: RouteData
Type Alias: RouteDataResolver
Type Alias: RouteMachineConfig
Type Alias: RouteMetadata
Interface: RouteObject
Type Alias: RouteStateNode
with-routing
with-view
Function: withRouting()
Function: withView()
shared
@xmachines/shared
Function: defineXmBrowserConfig()
Function: defineXmVitestConfig()
vite-aliases
vitest
Function: xmAliases()
Interface: XmBrowserConfigOptions
Function: xmCacheDir()
Function: xmOptimizeDeps()
Function: xmResolve()
Function: xmSvelteRunes()
Contributing
Overview
Architecture
Configuration
Deployment
Development
Testing
RFCs
All RFCs
RFC: Broker
RFC: Browser
RFC: CLI
RFC: Git
RFC: MCP
RFC: Node
RFC: Play
RFC: REST
RFC: Run
RFC: Streams
GitLab
Select theme
Dark
Light
Auto
Select language
English
vite-aliases
API
/
@xmachines/shared
/ vite-aliases
Functions
xmAliases
xmCacheDir
xmOptimizeDeps
xmResolve
xmSvelteRunes
4.0
en