Interface: ActorProviderProps

API / @xmachines/play-solid / ActorProviderProps

Defined in: packages/play-solid/src/ActorProvider.tsx:116

The props of ActorProvider, the low-level provider.

For the standard use, prefer PlayUIProvider. That component wraps ActorProvider with JSONUIProvider and with every necessary sub-provider.

Extends

BaseActorProviderProps<DefineRegistryResult>

Extended by

PlayUIProviderProps

Properties

Property	Type	Description	Inherited from	Defined in
`actor`	`ViewActor`	The actor instance with the currentView atom. It requires the Viewable capability.	`BaseActorProviderProps`.`actor`	packages/play-view/src/view-types.ts:219
`children`	`any`	The children. They are necessary, and they must hold a . You can also use the PlayUIProvider short form	-	packages/play-solid/src/ActorProvider.tsx:161
`fallback?`	`any`	The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error	-	packages/play-solid/src/ActorProvider.tsx:120
`onError?`	(`error`, `reset`) => `void`	The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The second parameter is the RESET, for a retry that the host starts — a “Retry” button of its own. It clears the caught error and renders again, and it resolves the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler starts no second retry, because no input changed between the two attempts, and a reset after the provider is disposed does nothing. The five renderers hold the same three rules. A handler that THROWS reaches no caller. The provider contains that throw, and it writes the throw to `console.error`. The fallback of this boundary is the RETURN of the callback that reports, so a throw that left this handler would take the fallback off the screen AND let the error escape the boundary. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule.	-	packages/play-solid/src/ActorProvider.tsx:156
`onRenderError?`	`OnRenderError`	The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry.	`BaseActorProviderProps`.`onRenderError`	packages/play-view/src/view-types.ts:236
`registryResult`	`DefineRegistryResult`	The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.	`BaseActorProviderProps`.`registryResult`	packages/play-view/src/view-types.ts:221
`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-view/src/view-types.ts:228