Interface: PlayUIProviderProps
API / @xmachines/play-react / PlayUIProviderProps
Defined in: packages/play-react/src/PlayUIProvider.tsx:34
Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider’s own props.
Extends
ActorProviderProps.Partial<JSONUIForwardedProps>
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actor | AbstractActor<AnyActorLogic, EventObject> & Viewable | Actor instance with currentView signal (requires Viewable capability). | ActorProviderProps.actor | packages/play-actor/src/abstract-actor.ts:154 |
children | ReactNode | Child components to render inside the provider tree | ActorProviderProps.children | packages/play-react/src/ActorProvider.tsx:37 |
fallback? | ReactNode | Optional component shown when currentView is null or a catalog component throws | ActorProviderProps.fallback | packages/play-react/src/ActorProvider.tsx:33 |
functions? | Record<string, ComputedFunction> | Named functions for $computed expressions in props | JSONUIProviderProps.functions | - |
navigate? | (path) => void | Navigation function | JSONUIProviderProps.navigate | - |
onError? | (error, info) => void | Optional error handler callback invoked when a catalog component throws during render | ActorProviderProps.onError | packages/play-react/src/ActorProvider.tsx:35 |
onRenderError? | RenderErrorHandler | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | ActorProviderProps.onRenderError | packages/play-actor/src/abstract-actor.ts:167 |
registryResult | DefineRegistryResult | Full result from defineRegistry() — contains the component registry and action handlers factory. | ActorProviderProps.registryResult | packages/play-actor/src/abstract-actor.ts:156 |
store? | StateStore | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | ActorProviderProps.store | packages/play-actor/src/abstract-actor.ts:162 |
validationFunctions? | Record<string, (value, args?) => boolean> | Custom validation functions | JSONUIProviderProps.validationFunctions | - |