Documentation
API Packages
play
play-actor
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>
- 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
- @xmachines/play-dom
- Interface: PlayDomOptions
- Class: PlayRenderer
- Type Alias: RenderErrorHandler
- Function: renderSpec()
- Variable: schema
- Type Alias: SetState
- Interface: UIProviderOptions
play-dom-router
- Interface: BrowserHistory
- Interface: BrowserWindow
- Function: connectRouter()
- Interface: ConnectRouterOptions
- Function: createBrowserHistory()
- Function: createRouteMap()
- Function: createRouter()
- @xmachines/play-dom-router
- Interface: PlayRouteEvent
- Interface: RoutableActor
- Interface: RouteLookupContract
- Interface: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Interface: VanillaRouter
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
- @xmachines/play-react
- 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
- Function: createRouteMap()
- Function: createRouteMapFromTree()
- @xmachines/play-react-router
- Interface: PlayActor
- Interface: PlayRouteEvent
- Function: PlayRouterProvider()
- Interface: PlayRouterProviderProps<TActor>
- Class: ReactRouterBridge
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
play-router
- Function: buildPlayRouteEvent()
- Interface: BuildPlayRouteEventOptions
- Function: buildRouteTree()
- Function: createRouteMap()
- Function: createRouteMapFromTree()
- Function: createRouteMatcher()
- 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()
- @xmachines/play-router
- Interface: PlayActor
- Interface: PlayRouteEvent
- Interface: RoutableActor
- Function: routeExists()
- Interface: RouteInfo
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouteMatch
- Interface: RouteMatcher
- 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
- Signal
- subtle
- 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>
- @xmachines/play-signals
- Interface: SignalComputed<T>
- Interface: SignalOptions<T>
- Interface: SignalState<T>
- Interface: SignalWatcher
- Class: State<T>
- Function: untrack()
- Variable: unwatched
- Variable: watched
- Class: Watcher
- Type Alias: WatcherNotify
- Function: watchSignal()
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
- @xmachines/play-solid
- 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
- Abstract Interface: AbstractActor<TLogic, TEvent>
- Function: createRouteMap()
- @xmachines/play-solid-router
- Interface: PlayActor
- Interface: PlayRouteEvent
- Function: PlayRouterProvider()
- Interface: PlayRouterProviderProps<TActor>
- Type Alias: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Class: SolidRouterBridge
- Type Alias: SolidRouterHooks
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()
- @xmachines/play-svelte
- Type Alias: PlayRenderer
- Variable: PlayRenderer
- Interface: PlayUIProviderProps
- Type Alias: RenderErrorHandler
- Function: setActorContext()
- Type Alias: SetState
- Interface: ViewContextValue
play-svelte-spa-router
play-sveltekit-router
play-tanstack-react-router
- Function: createRouteMap()
- Function: createRouteMapFromTree()
- Function: extractMachineRoutes()
- @xmachines/play-tanstack-react-router
- Interface: PlayActor
- Interface: PlayRouteEvent
- Function: PlayRouterProvider()
- Interface: PlayRouterProviderProps<TActor>
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouteNavigateEvent
- Interface: RouterBridge
- Class: TanStackReactRouterBridge
- Type Alias: TanStackRouterInstance
- Type Alias: TanStackRouterLike
play-tanstack-solid-router
- Function: createRouteMap()
- @xmachines/play-tanstack-solid-router
- Interface: PlayActor
- Interface: PlayRouteEvent
- Function: PlayRouterProvider()
- Interface: PlayRouterProviderProps<TActor>
- Type Alias: RoutableActor
- Class: RouteMap
- Interface: RouteMapOptions
- Interface: RouteMapping
- Interface: RouterBridge
- Type Alias: TanStackRouterInstance
- Type Alias: TanStackRouterLike
- Class: TanStackSolidRouterBridge
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
- @xmachines/play-vue
- 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
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()
- @xmachines/play-xstate
- 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