Interface: ActorProviderProps
API / @xmachines/play-react / ActorProviderProps
Defined in: packages/play-react/src/ActorProvider.tsx:53
The props of the ActorProvider component.
Extends
BaseActorProviderProps<DefineRegistryResult>
Extended by
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. | BaseActorProviderProps.actor | packages/play-actor/src/abstract-actor.ts:163 |
children | ReactNode | The child components to render inside the provider tree | - | packages/play-react/src/ActorProvider.tsx:59 |
fallback? | ReactNode | The component to show when currentView is null, or when a catalog component throws. This prop is optional | - | packages/play-react/src/ActorProvider.tsx:55 |
onError? | (error, info) => void | The optional error handler. The provider calls it when a catalog component throws during a render | - | packages/play-react/src/ActorProvider.tsx:57 |
onRenderError? | RenderErrorHandler | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry. | BaseActorProviderProps.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. | BaseActorProviderProps.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. | BaseActorProviderProps.store | packages/play-actor/src/abstract-actor.ts:172 |