Documentation
API Packages
play-actor
play-catalog
play-react
play-react-router
play-router
- @xmachines/play-router
- Class: BaseRouteMap
- Abstract Class: RouterBridgeBase
- 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
- subtle
- Signal
- @xmachines/play-signals
- Class: Computed<T>
- Class: State<T>
- Class: Watcher
- Interface: ComputedOptions<T>
- Interface: SignalComputed<T>
- Interface: SignalOptions<T>
- Interface: SignalState<T>
- Interface: SignalWatcher
- Interface: Options<T>
- Function: currentComputed()
- Function: hasSinks()
- Function: hasSources()
- Function: introspectSinks()
- Function: introspectSources()
- Function: untrack()
- Type Alias: WatcherNotify
- Variable: unwatched
- Variable: watched
- Variable: isComputed
- Variable: isState
- Variable: isWatcher
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-router
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