Interface: PlayUIProviderProps
API / @xmachines/play-vue / PlayUIProviderProps
Defined in: packages/play-vue/src/types.ts:29
The props of the ActorProvider component. This file holds them, so that TypeScript can re-export them. The vue-shim has a limit that stops a re-export from the .vue file.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actor | AbstractActor<AnyActorLogic, EventObject> & Viewable | The actor instance with the currentView signal. It requires the Viewable capability. | ActorProviderProps.actor | packages/play-actor/src/abstract-actor.ts:163 |
functions? | Record<string, (args?, state?) => unknown> | The named functions of a $computed expression in a prop | - | packages/play-vue/src/types.ts:38 |
navigate? | (path) => void | The navigate function. The provider gives it to JSONUIProvider, which resolves each link with it | - | packages/play-vue/src/types.ts:31 |
onRenderError? | RenderErrorHandler | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | ActorProviderProps.onRenderError | packages/play-actor/src/abstract-actor.ts:177 |
registryResult | DefineRegistryResult | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers. | ActorProviderProps.registryResult | packages/play-actor/src/abstract-actor.ts:165 |
store? | StateStore | The optional external StateStore, which is the controlled mode. With this option, the provider ignores spec.state, and this store is the single source of truth. Without it, the provider makes a new @xstate/store atom for each view transition, with the values of spec.state. | ActorProviderProps.store | packages/play-actor/src/abstract-actor.ts:172 |
validationFunctions? | Record<string, (value, args?) => boolean> | The validation functions. The provider gives them to JSONUIProvider | - | packages/play-vue/src/types.ts:33 |