Interface: PlayUIProviderProps
API / @xmachines/play-solid / PlayUIProviderProps
Defined in: packages/play-solid/src/PlayUIProvider.tsx:37
The props of PlayUIProvider — every ActorProvider prop, and also the props that it forwards to JSONUIProvider.
Extends
ActorProviderProps.Partial<JSONUIForwardedProps>
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 |
children | any | The children. They are necessary, and they must hold a | ActorProviderProps.children | packages/play-solid/src/ActorProvider.tsx:101 |
fallback? | any | The optional fallback element. The provider shows it when currentView is null, and when the ErrorBoundary catches an error | ActorProviderProps.fallback | packages/play-solid/src/ActorProvider.tsx:93 |
functions? | Record<string, ComputedFunction> | Named functions for $computed expressions in props | JSONUIProviderProps.functions | - |
navigate? | (path) => void | Navigation function | JSONUIProviderProps.navigate | - |
onError? | (error) => void | The optional callback. The provider calls it when the SolidJS ErrorBoundary catches an error | ActorProviderProps.onError | packages/play-solid/src/ActorProvider.tsx:96 |
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> | Custom validation functions | JSONUIProviderProps.validationFunctions | - |