Skip to content
XMachines
Search
Ctrl
K
Cancel
GitLab
Select theme
Dark
Light
Auto
Select language
English
Docs
Blog
Select documentation version
1.0.0 (latest)
2.0.0-alpha.1
Guides
Overview
Getting Started
Understanding State Machines in XMachines
Understanding the Actor Model and the Actor/Infrastructure Split
Understanding TC39 Signals in XMachines
Platform
Overview
Play
Browser
Node
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: assertNonNullable()
Class: NonNullableError
Class: PlayError
Type Alias: PlayEvent<TPayload>
play-actor
@xmachines/play-actor
Abstract Class: AbstractActor<TLogic, TEvent>
Function: attachRenderErrorHandler()
Interface: BaseActorProviderProps<TRegistry>
Interface: BaseViewContextValue<TRegistry>
Interface: PlaySpec
Interface: Routable
Function: toAtomState()
Function: typedSpec()
Interface: Viewable
play-dom
@xmachines/play-dom
Type Alias: ActionFn<C, K>
Type Alias: Actions<C>
Type Alias: BaseComponentProps<P>
Type Alias: CatalogHasActions<C>
Interface: ComponentContext<C, K>
Type Alias: ComponentFn<C, K>
Type Alias: ComponentRegistry<C>
Type Alias: ConfirmHandler
Function: createPlayUI()
Interface: CreatePlayUIOptions
Function: createRenderer()
Function: defineRegistry()
Type Alias: DefineRegistryOptions<C>
Interface: DefineRegistryResult
Type Alias: DomComponentRenderer
Type Alias: DomRegistry
Interface: DomRenderContext
Type Alias: DomSchema
Interface: EventHandle
Type Alias: MountFn
Interface: MountOptions
Interface: PlayDomOptions
Class: PlayRenderer
Type Alias: RenderErrorHandler
Function: renderSpec()
Interface: RenderSpecOptions
Variable: schema
Type Alias: SetState
Interface: UIProviderOptions
play-dom-router
@xmachines/play-dom-router
Interface: BrowserHistory
Interface: BrowserWindow
Function: connectRouter()
Interface: ConnectRouterOptions
Function: createBrowserHistory()
Function: createRouteMap()
Function: createRouter()
Interface: PlayRouteEvent
Interface: RoutableActor
Interface: RouteLookupContract
Interface: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
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
Function: StateProvider()
Interface: StateProviderProps
Function: useActor()
Function: useBoundProp()
Function: usePlayView()
Function: useSignalEffect()
Function: ValidationProvider()
Interface: ValidationProviderProps
Interface: ViewContextValue
Function: VisibilityProvider()
Interface: VisibilityProviderProps
play-react-router
@xmachines/play-react-router
Function: createPlayRouterProvider()
Function: createRouteMap()
Function: createRouteMapFromTree()
Interface: PlayActor
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter>
Variable: PlayRouterProvider
Interface: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Class: ReactRouterBridge
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
play-router
@xmachines/play-router
Function: buildPlayRouteEvent()
Interface: BuildPlayRouteEventOptions
Function: buildRouteTree()
Function: createRouteMap()
Function: createRouteMapFromTree()
Function: detectDuplicateRoutes()
Function: extractMachineRoutes()
Function: extractQuery()
Function: extractRouteParams()
Function: findRouteById()
Function: findRouteByPath()
Function: getNavigableRoutes()
Function: getRoutableRoutes()
Function: getTransitionReachableRoutes()
Function: isRouteReachable()
Interface: LocationLike
Interface: MachineEdgeData
Type Alias: MachineGraph
Interface: MachineNodeData
Function: machineToGraph()
Interface: PlayActor
Interface: PlayRouteEvent
Interface: ResolvedRoutePath
Interface: RoutableActor
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: RouteTree
Interface: RouteWatcherHandle
Function: sanitizePathname()
Function: validateRouteFormat()
Function: validateStateExists()
Interface: WindowLike
play-signals
@xmachines/play-signals
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
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
Abstract Interface: AbstractActor<TLogic, TEvent>
Function: createPlayRouterProvider()
Function: createRouteMap()
Interface: PlayActor
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter>
Variable: PlayRouterProvider
Interface: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Type Alias: 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
Function: setActorContext()
Type Alias: SetState
Interface: ViewContextValue
play-svelte-spa-router
@xmachines/play-svelte-spa-router
Function: connectRouter()
Interface: ConnectRouterOptions
Function: createRouteMap()
Interface: PlayRouteEvent
Type Alias: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Interface: WindowLike
play-sveltekit-router
@xmachines/play-sveltekit-router
Function: connectRouter()
Interface: ConnectRouterOptions
Function: createRouteMap()
Interface: LocationLike
Interface: PlayRouteEvent
Type Alias: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
play-tanstack-react-router
@xmachines/play-tanstack-react-router
Function: createPlayRouterProvider()
Function: createRouteMap()
Function: createRouteMapFromTree()
Function: extractMachineRoutes()
Interface: PlayActor
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter>
Variable: PlayRouterProvider
Interface: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouteNavigateEvent
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()
Function: createRouteMap()
Interface: PlayActor
Interface: PlayRouteEvent
Type Alias: PlayRouterBridgeConstructor<TRouter>
Variable: PlayRouterProvider
Interface: PlayRouterProviderBaseProps<TRouter, TActor>
Interface: PlayRouterProviderProps<TActor>
Type Alias: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Type Alias: TanStackRouterInstance
Type Alias: TanStackRouterLike
Class: TanStackSolidRouterBridge
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
Function: getPlayViewContext()
Variable: JSONUIProvider
Interface: JSONUIProviderProps
Variable: PlayRenderer
Interface: PlayUIProviderProps
Variable: Renderer
Interface: RendererProps
Type Alias: RenderErrorHandler
Variable: StateProvider
Interface: StateProviderProps
Function: useActor()
Function: useBoundProp()
Variable: ValidationProvider
Interface: ValidationProviderProps
Interface: ViewContextValue
Variable: VisibilityProvider
Interface: VisibilityProviderProps
play-vue-router
@xmachines/play-vue-router
Function: createRouteMap()
Interface: PlayActor
Interface: PlayRouteEvent
Variable: PlayRouterProvider
Type Alias: RoutableActor
Class: RouteMap
Interface: RouteMapOptions
Interface: RouteMapping
Interface: RouterBridge
Class: VueRouterBridge
play-xstate
@xmachines/play-xstate
Function: buildRouteUrl()
Type Alias: ComposedGuard
Function: composeGuards()
Function: composeGuardsOr()
Function: contextFieldMatches()
Function: definePlayer()
Function: deriveRoute()
Function: eventMatches()
Function: formatPlayRouteTransitions()
Type Alias: Guard<TContext, TEvent>
Type Alias: GuardArray<TContext, TEvent>
Function: hasContext()
Function: isAbsoluteRoute()
Function: negateGuard()
Class: PlayerActor<TMachine>
Interface: PlayerConfig<TMachine>
Type Alias: PlayerFactory<TMachine>
Interface: PlayerFactoryResumeOptions<TMachine>
Interface: PlayerOptions<TMachine>
Interface: RouteContext
Type Alias: RouteMachineConfig
Type Alias: RouteMetadata
Interface: RouteObject
Type Alias: RouteStateNode
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
Type Alias: JSONUIProviderProps
API
/
@xmachines/play-svelte
/ JSONUIProviderProps
type
JSONUIProviderProps
=
any
;
1.0.0
en