Skip to content
XMachines
Search
Ctrl
K
Cancel
GitLab
Select theme
Dark
Light
Auto
Guides
Getting Started
Installation
Platform
Overview
Play
Browser
Node
Examples
Browse Examples
Basic State Machine
Form Validation State Machine
Multi-Router Integration - Renderer Prop Pattern
Routing Patterns - Play Architecture
Traffic Light State Machine
Demos
React Router Demo
Vanilla JavaScript Router Demo
Solid Router Demo
TanStack React Router Demo
TanStack Solid Router Demo
Vue Router Demo
API
API Reference
play
@xmachines/play
Type Alias: PlayEvent<TPayload>
play-actor
@xmachines/play-actor
Abstract Class: AbstractActor<TLogic>
Interface: Routable
Interface: Viewable
Interface: ViewMetadata
play-catalog
@xmachines/play-catalog
Function: defineCatalog()
Function: defineComponents()
Type Alias: Catalog<TCatalog>
Type Alias: ComponentsFor<TCatalog>
Type Alias: InferComponentProps<TCatalog, TKey>
Type Alias: NoExtraKeys<TComponents, TCatalog>
play-react
@xmachines/play-react
Class: PlayErrorBoundary
Interface: PlayErrorBoundaryProps
Interface: PlayErrorBoundaryState
Interface: PlayRendererProps
Function: useSignalEffect()
Variable: PlayRenderer
play-react-router
@xmachines/play-react-router
Class: ReactRouterBridge
Class: RouteMap
Interface: PlayRouteEvent
Interface: PlayRouterProviderProps
Interface: RouteMapping
Interface: RouterBridge
Function: createRouteMapFromTree()
Function: PlayRouterProvider()
play-router
@xmachines/play-router
Abstract Class: RouterBridgeBase
Class: BaseRouteMap
Interface: BaseRouteMapping
Interface: BrowserHistory
Interface: BrowserWindow
Interface: ConnectRouterOptions
Interface: PlayRouteEvent
Interface: RouteInfo
Interface: RouteMap
Interface: RouteNode
Interface: RouteObject
Interface: RouterBridge
Interface: RouteTree
Interface: StateVisit
Interface: VanillaRouter
Function: buildRouteTree()
Function: connectRouter()
Function: crawlMachine()
Function: createBrowserHistory()
Function: createRouteMap()
Function: createRouter()
Function: detectDuplicateRoutes()
Function: extractMachineRoutes()
Function: extractRoute()
Function: findRouteById()
Function: findRouteByPath()
Function: getNavigableRoutes()
Function: getRoutableRoutes()
Function: routeExists()
Function: validateRouteFormat()
Function: validateStateExists()
Type Alias: RouteMetadata
play-signals
@xmachines/play-signals
Class: Computed<T>
Class: State<T>
Class: Watcher
Interface: ComputedOptions<T>
Interface: Options<T>
Interface: SignalComputed<T>
Interface: SignalOptions<T>
Interface: SignalState<T>
Interface: SignalWatcher
Function: currentComputed()
Function: hasSinks()
Function: hasSources()
Function: introspectSinks()
Function: introspectSources()
Function: untrack()
Type Alias: WatcherNotify
Variable: isComputed
Variable: isState
Variable: isWatcher
Variable: unwatched
Variable: watched
Signal
subtle
play-solid
@xmachines/play-solid
Interface: PlayRendererProps
Variable: PlayRenderer
play-solid-router
@xmachines/play-solid-router
Class: RouteMap
Class: SolidRouterBridge
Abstract Interface: AbstractActor<TLogic>
Interface: PlayRouteEvent
Interface: PlayRouterProviderProps
Interface: RouteMapping
Interface: RouterBridge
Function: createRouteMap()
Function: PlayRouterProvider()
Type Alias: RoutableActor
Type Alias: SolidRouterHooks
play-tanstack-react-router
@xmachines/play-tanstack-react-router
Class: RouteMap
Class: TanStackReactRouterBridge
Interface: PlayRouteEvent
Interface: PlayRouterProviderProps
Interface: RouteMapping
Interface: RouteNavigateEvent
Interface: RouterBridge
Function: createRouteMap()
Function: createRouteMapFromTree()
Function: extractParams()
Function: extractQueryParams()
Function: PlayRouterProvider()
Type Alias: TanStackRouterInstance
Type Alias: TanStackRouterLike
Variable: extractMachineRoutes
play-tanstack-solid-router
@xmachines/play-tanstack-solid-router
Class: RouteMap
Class: SolidRouterBridge
Interface: PlayRouteEvent
Interface: PlayRouterProviderProps
Interface: RouteMapping
Interface: RouterBridge
Function: createRouteMap()
Function: PlayRouterProvider()
Type Alias: RoutableActor
Type Alias: TanStackRouterInstance
Type Alias: TanStackRouterLike
play-vue
@xmachines/play-vue
Interface: PlayRendererProps
Variable: PlayRenderer
play-vue-router
@xmachines/play-vue-router
Class: RouteMap
Class: VueBaseRouteMap
Class: VueRouterBridge
Interface: PlayRouteEvent
Interface: RouteMapping
Interface: RouterBridge
Function: createRouteMap()
Type Alias: RoutableActor
Variable: PlayRouterProvider
play-xstate
@xmachines/play-xstate
Class: PlayerActor<TMachine>
Interface: CatalogEntry
Interface: PlayerConfig<TMachine, TCatalog>
Interface: PlayerOptions<TMachine>
Interface: RouteContext
Function: buildRouteUrl()
Function: composeGuards()
Function: composeGuardsOr()
Function: definePlayer()
Function: deriveRoute()
Function: eventMatches()
Function: formatPlayRouteTransitions()
Function: hasContext()
Function: isAbsoluteRoute()
Function: mergeViewProps()
Function: negateGuard()
Function: stateMatches()
Function: validateComponentBinding()
Function: validateViewProps()
Type Alias: Catalog
Type Alias: ComposedGuard
Type Alias: Guard<TContext, TEvent>
Type Alias: GuardArray<TContext, TEvent>
Type Alias: PlayerFactory<TMachine>
Type Alias: RouteMachineConfig
Type Alias: RouteStateNode
Type Alias: ValidationResult
Type Alias: ViewMergeContext
shared
@xmachines/shared
Function: defineXmVitestConfig()
Function: xmAliases()
RFCs
All RFCs
RFC: Broker (v1)
RFC: Browser (v1)
RFC: CLI (v1)
RFC: Git (v1)
RFC: MCP (v1)
RFC: Node (v1)
RFC: Play (v1)
RFC: REST (v1)
RFC: Run (v1)
RFC: Streams (v1)
GitLab
Select theme
Dark
Light
Auto
RFCs
RFC: Broker (v1)
RFC: Browser (v1)
RFC: CLI (v1)
RFC: Git (v1)
RFC: MCP (v1)
RFC: Node (v1)
RFC: Play (v1)
RFC: REST (v1)
RFC: Run (v1)
RFC: Streams (v1)