@xmachines/docs 1.0.0-beta.9 → 1.1.0

package/api/@xmachines/play-solid/functions/defineRegistry.md

@@ -0,0 +1,49 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / defineRegistry
+
+# Function: defineRegistry()
+
+```ts
+function defineRegistry<C>(_catalog, options): DefineRegistryResult;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+Create a registry from a catalog with components and/or actions.
+
+When the catalog declares actions, the `actions` field is required.
+
+## Type Parameters
+
+| Type Parameter                                                                                                                       |
+| ------------------------------------------------------------------------------------------------------------------------------------ |
+| `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
+
+## Parameters
+
+| Parameter  | Type                           |
+| ---------- | ------------------------------ |
+| `_catalog` | `C`                            |
+| `options`  | `DefineRegistryOptions`\<`C`\> |
+
+## Returns
+
+[`DefineRegistryResult`](../interfaces/DefineRegistryResult.md)
+
+## Example
+
+```tsx
+// Components only (catalog has no actions)
+const { registry } = defineRegistry(catalog, {
+  components: {
+    Card: (ctx) => (
+      <div class="card">{ctx.props.title}{ctx.children}</div>
+    ),
+  },
+});
+
+// Both (catalog declares actions)
+const { registry, handlers, executeAction } = defineRegistry(catalog, {
+  components: { ... },
+  actions: { ... },
+});
+```

package/api/@xmachines/play-solid/functions/useAction.md

@@ -0,0 +1,24 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useAction
+
+# Function: useAction()
+
+```ts
+function useAction(binding): object;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Parameters
+
+| Parameter | Type            |
+| --------- | --------------- |
+| `binding` | `ActionBinding` |
+
+## Returns
+
+`object`
+
+| Name        | Type                      | Defined in |
+| ----------- | ------------------------- | ---------- |
+| `execute()` | () => `Promise`\<`void`\> | -          |
+| `isLoading` | `boolean`                 | -          |

package/api/@xmachines/play-solid/functions/useActions.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useActions
+
+# Function: useActions()
+
+```ts
+function useActions(): ActionContextValue;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Returns
+
+`ActionContextValue`

package/api/@xmachines/play-solid/functions/useActor.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useActor
+
+# Function: useActor()
+
+```ts
+function useActor(): AnyPlayActor;
+```
+
+Defined in: [packages/play-solid/src/useActor.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/useActor.ts#L37)
+
+## Returns
+
+[`AnyPlayActor`](../type-aliases/AnyPlayActor.md)

package/api/@xmachines/play-solid/functions/useBoundProp.md

@@ -0,0 +1,45 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useBoundProp
+
+# Function: useBoundProp()
+
+```ts
+function useBoundProp<T>(propValue, bindingPath): [T | undefined, (value) => void];
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+Hook for two-way bound props. Returns `[value, setValue]` where:
+
+- `value` is the already-resolved prop value (passed through from render props)
+- `setValue` writes back to the bound state path (no-op if not bound)
+
+Designed to work with the `bindings` map that the renderer provides when
+a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Parameters
+
+| Parameter     | Type                    |
+| ------------- | ----------------------- |
+| `propValue`   | `T` \| `undefined`      |
+| `bindingPath` | `string` \| `undefined` |
+
+## Returns
+
+\[`T` \| `undefined`, (`value`) => `void`\]
+
+## Example
+
+```tsx
+import { useBoundProp } from "@xmachines/json-render-solid";
+
+const Input: ComponentRenderer = (ctx) => {
+	const [value, setValue] = useBoundProp<string>(ctx.props.value, ctx.bindings?.value);
+	return <input value={value ?? ""} onInput={(e) => setValue(e.target.value)} />;
+};
+```

package/api/@xmachines/play-solid/functions/useFieldValidation.md

@@ -0,0 +1,29 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useFieldValidation
+
+# Function: useFieldValidation()
+
+```ts
+function useFieldValidation(path, config?): object;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Parameters
+
+| Parameter | Type               |
+| --------- | ------------------ |
+| `path`    | `string`           |
+| `config?` | `ValidationConfig` |
+
+## Returns
+
+`object`
+
+| Name         | Type                                 | Defined in |
+| ------------ | ------------------------------------ | ---------- |
+| `clear()`    | () => `void`                         | -          |
+| `errors`     | `Accessor`\<`string`[]\>             | -          |
+| `isValid`    | `Accessor`\<`boolean`\>              | -          |
+| `state`      | `Accessor`\<`FieldValidationState`\> | -          |
+| `touch()`    | () => `void`                         | -          |
+| `validate()` | () => `ValidationResult`             | -          |

package/api/@xmachines/play-solid/functions/useIsVisible.md

@@ -0,0 +1,19 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useIsVisible
+
+# Function: useIsVisible()
+
+```ts
+function useIsVisible(condition): boolean;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Parameters
+
+| Parameter   | Type                                 |
+| ----------- | ------------------------------------ |
+| `condition` | `VisibilityCondition` \| `undefined` |
+
+## Returns
+
+`boolean`

package/api/@xmachines/play-solid/functions/useOptionalValidation.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useOptionalValidation
+
+# Function: useOptionalValidation()
+
+```ts
+function useOptionalValidation(): ValidationContextValue | null;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Returns
+
+`ValidationContextValue` \| `null`

package/api/@xmachines/play-solid/functions/usePlayView.md

@@ -0,0 +1,30 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / usePlayView
+
+# Function: usePlayView()
+
+```ts
+function usePlayView(): ViewContextValue;
+```
+
+Defined in: [packages/play-solid/src/ActorProvider.tsx:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L75)
+
+Hook to access the current view context inside an ActorProvider tree.
+
+## Returns
+
+[`ViewContextValue`](../interfaces/ViewContextValue.md)
+
+## Throws
+
+If called outside an ActorProvider (or PlayUIProvider) tree
+
+## Example
+
+```tsx
+import { usePlayView } from "@xmachines/play-solid";
+
+const MyRenderer: Component = () => {
+	const view = usePlayView();
+	return <Renderer spec={view.spec} registry={view.registry} />;
+};
+```

package/api/@xmachines/play-solid/functions/useStateBinding.md

@@ -0,0 +1,25 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useStateBinding
+
+# Function: useStateBinding()
+
+```ts
+function useStateBinding<T>(path): [Accessor<T | undefined>, (value) => void];
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+## Returns
+
+\[`Accessor`\<`T` \| `undefined`\>, (`value`) => `void`\]

package/api/@xmachines/play-solid/functions/useStateStore.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useStateStore
+
+# Function: useStateStore()
+
+```ts
+function useStateStore(): StateContextValue;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Returns
+
+`StateContextValue`

package/api/@xmachines/play-solid/functions/useStateValue.md

@@ -0,0 +1,25 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useStateValue
+
+# Function: useStateValue()
+
+```ts
+function useStateValue<T>(path): Accessor<T | undefined>;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+## Returns
+
+`Accessor`\<`T` \| `undefined`\>

package/api/@xmachines/play-solid/functions/useVisibility.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / useVisibility
+
+# Function: useVisibility()
+
+```ts
+function useVisibility(): VisibilityContextValue;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+## Returns
+
+`VisibilityContextValue`

package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md

@@ -0,0 +1,12 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ActionProviderProps
+
+# Interface: ActionProviderProps
+
+Defined in: `@xmachines/json-render-solid`
+
+## Properties
+
+| Property                                   | Type                                  | Defined in |
+| ------------------------------------------ | ------------------------------------- | ---------- |
+| <a id="property-handlers"></a> `handlers?` | `Record`\<`string`, `ActionHandler`\> | -          |
+| <a id="property-navigate"></a> `navigate?` | (`path`) => `void`                    | -          |

package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md

@@ -0,0 +1,30 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ActorProviderProps
+
+# Interface: ActorProviderProps
+
+Defined in: [packages/play-solid/src/ActorProvider.tsx:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L89)
+
+Props for ActorProvider — the escape hatch primitive.
+
+For batteries-included usage, prefer PlayUIProvider which wraps ActorProvider
+with JSONUIProvider and all required sub-providers.
+
+## Extends
+
+- [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md)\<[`DefineRegistryResult`](DefineRegistryResult.md)\>
+
+## Extended by
+
+- [`PlayUIProviderProps`](PlayUIProviderProps.md)
+
+## Properties
+
+| Property                                              | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                 | Inherited from                                                                                                                                                                      | Defined in                                                                                                                                               |
+| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L159) |
+| <a id="property-children"></a> `children`             | `any`                                                                                                                                                                                                                                                            | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand)                                                                                                                                        | -                                                                                                                                                                                   | [packages/play-solid/src/ActorProvider.tsx:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L97)   |
+| <a id="property-fallback"></a> `fallback?`            | `any`                                                                                                                                                                                                                                                            | Optional fallback element shown when currentView is null or ErrorBoundary catches                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L91)   |
+| <a id="property-onerror"></a> `onError?`              | (`error`) => `void`                                                                                                                                                                                                                                              | Optional callback invoked when SolidJS ErrorBoundary catches an error                                                                                                                                                       | -                                                                                                                                                                                   | [packages/play-solid/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L94)   |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L161) |
+| <a id="property-store"></a> `store?`                  | `StateStore`                                                                                                                                                                                                                                                     | Optional 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. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L167) |

package/api/@xmachines/play-solid/interfaces/ComponentContext.md

@@ -0,0 +1,37 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ComponentContext
+
+# Interface: ComponentContext\<C, K\>
+
+Defined in: `@xmachines/json-render-solid`
+
+Context passed to component render functions
+
+## Example
+
+```ts
+const Button: ComponentFn<typeof catalog, 'Button'> = (ctx) => {
+  return <button onClick={() => ctx.emit("press")}>{ctx.props.label}</button>
+}
+```
+
+## Extends
+
+- `BaseComponentProps`\<`InferComponentProps`\<`C`, `K`\>\>
+
+## Type Parameters
+
+| Type Parameter                                      |
+| --------------------------------------------------- |
+| `C` _extends_ `Catalog`                             |
+| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
+
+## Properties
+
+| Property                                   | Type                           | Description                                                                                                                      | Inherited from                | Defined in |
+| ------------------------------------------ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | ---------- |
+| <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\> | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | `BaseComponentProps.bindings` | -          |
+| <a id="property-children"></a> `children?` | `any`                          | -                                                                                                                                | `BaseComponentProps.children` | -          |
+| <a id="property-emit"></a> `emit`          | (`event`) => `void`            | Simple event emitter (shorthand). Fires the event and returns void.                                                              | `BaseComponentProps.emit`     | -          |
+| <a id="property-loading"></a> `loading?`   | `boolean`                      | -                                                                                                                                | `BaseComponentProps.loading`  | -          |
+| <a id="property-on"></a> `on`              | (`event`) => `EventHandle`     | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks.                                       | `BaseComponentProps.on`       | -          |
+| <a id="property-props"></a> `props`        | `InferComponentProps`          | -                                                                                                                                | `BaseComponentProps.props`    | -          |

package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md

@@ -0,0 +1,15 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / DefineRegistryResult
+
+# Interface: DefineRegistryResult
+
+Defined in: `@xmachines/json-render-solid`
+
+Result returned by defineRegistry
+
+## Properties
+
+| Property                                            | Type                                                                                   | Description                                                                                                                                         | Defined in |
+| --------------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
+| <a id="property-executeaction"></a> `executeAction` | (`actionName`, `params`, `setState`, `state?`) => `Promise`\<`void`\>                  | Execute an action by name imperatively (for use outside the Solid tree, e.g. initial state loading).                                                | -          |
+| <a id="property-handlers"></a> `handlers`           | (`getSetState`, `getState`) => `Record`\<`string`, (`params`) => `Promise`\<`void`\>\> | Create ActionProvider-compatible handlers. Accepts getter functions so handlers always read the latest state/setState (e.g. from refs or closures). | -          |
+| <a id="property-registry"></a> `registry`           | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)                            | Component registry for `<Renderer registry={...} />`                                                                                                | -          |

package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md

@@ -0,0 +1,22 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / JSONUIProviderProps
+
+# Interface: JSONUIProviderProps
+
+Defined in: `@xmachines/json-render-solid`
+
+Props for JSONUIProvider
+
+## Properties
+
+| Property                                                         | Type                                                                                                      | Description                                                                                      | Defined in |
+| ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------- |
+| <a id="property-children"></a> `children`                        | `any`                                                                                                     | -                                                                                                | -          |
+| <a id="property-directives"></a> `directives?`                   | `DirectiveDefinition`\<`ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>\>[] | Custom directives for user-defined `$`-prefixed dynamic values                                   | -          |
+| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, `ComputedFunction`\>                                                                  | Named functions for `$computed` expressions in props                                             | -          |
+| <a id="property-handlers"></a> `handlers?`                       | `Record`\<`string`, (`params`) => `unknown`\>                                                             | Action handlers                                                                                  | -          |
+| <a id="property-initialstate"></a> `initialState?`               | `Record`\<`string`, `unknown`\>                                                                           | Initial state model (uncontrolled mode)                                                          | -          |
+| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                        | Navigation function                                                                              | -          |
+| <a id="property-onstatechange"></a> `onStateChange?`             | (`changes`) => `void`                                                                                     | Callback when state changes (uncontrolled mode)                                                  | -          |
+| <a id="property-registry"></a> `registry`                        | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)                                               | Component registry                                                                               | -          |
+| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                              | External store (controlled mode). When provided, `initialState` and `onStateChange` are ignored. | -          |
+| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                     | Custom validation functions                                                                      | -          |

package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md

@@ -0,0 +1,26 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayUIProviderProps
+
+# Interface: PlayUIProviderProps
+
+Defined in: [packages/play-solid/src/PlayUIProvider.tsx:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/PlayUIProvider.tsx#L36)
+
+Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's forwarded props.
+
+## Extends
+
+- [`ActorProviderProps`](ActorProviderProps.md).`Partial`\<`JSONUIForwardedProps`\>
+
+## Properties
+
+| Property                                                         | Type                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                 | Inherited from                                                                                                               | Defined in                                                                                                                                               |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                              | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability).                                                                                                                                                      | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor)                                | [packages/play-actor/src/abstract-actor.ts:159](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L159) |
+| <a id="property-children"></a> `children`                        | `any`                                                                                                                                                                                                                                                            | Children — required; must include <PlayRenderer /> (or use PlayUIProvider shorthand)                                                                                                                                        | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children)                          | [packages/play-solid/src/ActorProvider.tsx:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L97)   |
+| <a id="property-fallback"></a> `fallback?`                       | `any`                                                                                                                                                                                                                                                            | Optional fallback element shown when currentView is null or ErrorBoundary catches                                                                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback)                          | [packages/play-solid/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L91)   |
+| <a id="property-functions"></a> `functions?`                     | `Record`\<`string`, `ComputedFunction`\>                                                                                                                                                                                                                         | Named functions for `$computed` expressions in props                                                                                                                                                                        | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`functions`](JSONUIProviderProps.md#property-functions)                     | -                                                                                                                                                        |
+| <a id="property-navigate"></a> `navigate?`                       | (`path`) => `void`                                                                                                                                                                                                                                               | Navigation function                                                                                                                                                                                                         | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`navigate`](JSONUIProviderProps.md#property-navigate)                       | -                                                                                                                                                        |
+| <a id="property-onerror"></a> `onError?`                         | (`error`) => `void`                                                                                                                                                                                                                                              | Optional callback invoked when SolidJS ErrorBoundary catches an error                                                                                                                                                       | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror)                            | [packages/play-solid/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L94)   |
+| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry.                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror)                | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <a id="property-registryresult"></a> `registryResult`            | [`DefineRegistryResult`](DefineRegistryResult.md)                                                                                                                                                                                                                | Full result from defineRegistry() — contains the component registry and action handlers factory.                                                                                                                            | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult)              | [packages/play-actor/src/abstract-actor.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L161) |
+| <a id="property-store"></a> `store?`                             | `StateStore`                                                                                                                                                                                                                                                     | Optional 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`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store)                                | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L167) |
+| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Custom validation functions                                                                                                                                                                                                 | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | -                                                                                                                                                        |

package/api/@xmachines/play-solid/interfaces/RendererProps.md

@@ -0,0 +1,17 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / RendererProps
+
+# Interface: RendererProps
+
+Defined in: `@xmachines/json-render-solid`
+
+Props for the Renderer component
+
+## Properties
+
+| Property                                             | Type                                                          | Description                                                     | Defined in |
+| ---------------------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------- | ---------- |
+| <a id="property-fallback"></a> `fallback?`           | `ComponentRenderer`\<`Record`\<`string`, `unknown`\>\>        | Fallback component for unknown types                            | -          |
+| <a id="property-loading"></a> `loading?`             | `boolean`                                                     | Whether the spec is currently loading/streaming                 | -          |
+| <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md) | Callback for element render errors caught by the inner boundary | -          |
+| <a id="property-registry"></a> `registry`            | [`ComponentRegistry`](../type-aliases/ComponentRegistry.md)   | Component registry                                              | -          |
+| <a id="property-spec"></a> `spec`                    | `Spec` \| `null`                                              | The UI spec to render                                           | -          |

package/api/@xmachines/play-solid/interfaces/StateProviderProps.md

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / StateProviderProps
+
+# Interface: StateProviderProps
+
+Defined in: `@xmachines/json-render-solid`
+
+## Properties
+
+| Property                                             | Type                  | Defined in |
+| ---------------------------------------------------- | --------------------- | ---------- |
+| <a id="property-initialstate"></a> `initialState?`   | `StateModel`          | -          |
+| <a id="property-onstatechange"></a> `onStateChange?` | (`changes`) => `void` | -          |
+| <a id="property-store"></a> `store?`                 | `StateStore`          | -          |

package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ValidationProviderProps
+
+# Interface: ValidationProviderProps
+
+Defined in: `@xmachines/json-render-solid`
+
+## Properties
+
+| Property                                                 | Type                                       | Defined in |
+| -------------------------------------------------------- | ------------------------------------------ | ---------- |
+| <a id="property-customfunctions"></a> `customFunctions?` | `Record`\<`string`, `ValidationFunction`\> | -          |

package/api/@xmachines/play-solid/interfaces/ViewContextValue.md

@@ -0,0 +1,21 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ViewContextValue
+
+# Interface: ViewContextValue
+
+Defined in: [packages/play-solid/src/ActorProvider.tsx:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/ActorProvider.tsx#L56)
+
+Value provided by ActorProvider's ViewContext.
+Access via usePlayView() inside the ActorProvider tree.
+
+## Extends
+
+- [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md)\<[`ComponentRegistry`](../type-aliases/ComponentRegistry.md)\>
+
+## Properties
+
+| Property                                  | Type                                                  | Description                                                                                               | Inherited from                                                                                                                                                    | Defined in                                                                                                                                               |
+| ----------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\>                 | Action handlers resolved against the live StateStore.                                                     | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`handlers`](../../play-actor/interfaces/BaseViewContextValue.md#property-handlers) | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L127) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                                           | Component registry from registryResult.registry.                                                          | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`registry`](../../play-actor/interfaces/BaseViewContextValue.md#property-registry) | [packages/play-actor/src/abstract-actor.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L129) |
+| <a id="property-spec"></a> `spec`         | [`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) | The current PlaySpec to render.                                                                           | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`spec`](../../play-actor/interfaces/BaseViewContextValue.md#property-spec)         | [packages/play-actor/src/abstract-actor.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L125) |
+| <a id="property-store"></a> `store`       | `StateStore`                                          | The active StateStore — pass to JSONUIProvider/JsonUIProvider as `store` to share state across providers. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store)       | [packages/play-actor/src/abstract-actor.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-actor/src/abstract-actor.ts#L131) |

package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / AnyPlayActor
+
+# Type Alias: AnyPlayActor
+
+```ts
+type AnyPlayActor = AbstractActor<AnyActorLogic>;
+```
+
+Defined in: [packages/play-solid/src/useActor.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.1.0/packages/play-solid/src/useActor.ts#L28)
+
+Bare actor type accepted by Solid context providers. For the full routing + view shape, use `PlayActor` from `@xmachines/play-router`.

package/api/@xmachines/play-solid/type-aliases/ComponentFn.md

@@ -0,0 +1,36 @@
+[API](../../../README.md) / [@xmachines/play-solid](../README.md) / ComponentFn
+
+# Type Alias: ComponentFn\<C, K\>
+
+```ts
+type ComponentFn<C, K> = (ctx) => JSX.Element;
+```
+
+Defined in: `@xmachines/json-render-solid`
+
+Component render function type for Solid
+
+## Type Parameters
+
+| Type Parameter                                      |
+| --------------------------------------------------- |
+| `C` _extends_ `Catalog`                             |
+| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
+
+## Parameters
+
+| Parameter | Type                                                                |
+| --------- | ------------------------------------------------------------------- |
+| `ctx`     | [`ComponentContext`](../interfaces/ComponentContext.md)\<`C`, `K`\> |
+
+## Returns
+
+`JSX.Element`
+
+## Example
+
+```ts
+const Button: ComponentFn<typeof catalog, 'Button'> = (ctx) => (
+  <button onClick={() => ctx.emit("press")}>{ctx.props.label}</button>
+);
+```