Skip to content

Interface: PlayUIProviderProps

API / @xmachines/play-solid / PlayUIProviderProps

Defined in: packages/play-solid/src/PlayUIProvider.tsx:36

Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider’s forwarded props.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
actorAbstractActor<AnyActorLogic, EventObject> & ViewableActor instance with currentView signal (requires Viewable capability).ActorProviderProps.actorpackages/play-actor/src/abstract-actor.ts:154
childrenanyChildren — required; must include (or use PlayUIProvider shorthand)ActorProviderProps.childrenpackages/play-solid/src/ActorProvider.tsx:91
fallback?anyOptional fallback element shown when currentView is null or ErrorBoundary catchesActorProviderProps.fallbackpackages/play-solid/src/ActorProvider.tsx:85
functions?Record<string, ComputedFunction>Named functions for $computed expressions in propsJSONUIProviderProps.functions-
navigate?(path) => voidNavigation functionJSONUIProviderProps.navigate-
onError?(error) => voidOptional callback invoked when SolidJS ErrorBoundary catches an errorActorProviderProps.onErrorpackages/play-solid/src/ActorProvider.tsx:88
onRenderError?RenderErrorHandlerCalled when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.ActorProviderProps.onRenderErrorpackages/play-actor/src/abstract-actor.ts:167
registryResultDefineRegistryResultFull result from defineRegistry() — contains the component registry and action handlers factory.ActorProviderProps.registryResultpackages/play-actor/src/abstract-actor.ts:156
store?StateStoreOptional 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.storepackages/play-actor/src/abstract-actor.ts:162
validationFunctions?Record<string, (value, args?) => boolean>Custom validation functionsJSONUIProviderProps.validationFunctions-