npm - @xmachines/docs - Versions diffs - 2.0.0 → 2.1.0 - Mend

@xmachines/docs 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (299) hide show

package/api/@xmachines/play-react/classes/PlayErrorBoundary.md CHANGED Viewed

@@ -2,19 +2,20 @@
 # Class: PlayErrorBoundary
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L53)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L54)
-React class component error boundary for catching catalog component render errors.
+The React class component that catches a render error of a catalog component.
-Wraps catalog component renders so failures are caught and forwarded to standard
-React error boundary protocol. Consumers can attach the `onError` prop to forward
-errors to production observability tools (Sentry, Datadog, etc.).
+It wraps each render of a catalog component. It catches a failure and sends it to
+the standard React error boundary protocol. Attach the `onError` prop to send
+each error to an observability tool in production, such as Sentry or Datadog.
-**React 19 safety (Phase 29):** `componentDidCatch` calls `onError` for observability
-but does NOT re-throw. `getDerivedStateFromError` already sets the fallback state —
-re-throwing from `componentDidCatch` can unmount the entire React 19 root.
+**React 19 safety (Phase 29):** `componentDidCatch` calls `onError` for the
+observability, but it does NOT throw the error again. `getDerivedStateFromError`
+sets the fallback state already, and a throw from `componentDidCatch` can unmount
+the complete React 19 root.
-Per CONS-14: Class component pattern works with all React versions (18 and 19).
+CONS-14: the class component pattern works with every React version, 18 and 19.
 ## Example
@@ -36,7 +37,7 @@ Per CONS-14: Class component pattern works with all React versions (18 and 19).
 new PlayErrorBoundary(props): PlayErrorBoundary;
 ```
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L57)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L58)
 #### Parameters
@@ -75,7 +76,7 @@ React.Component<
 componentDidCatch(error, info): void;
 ```
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L66)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L67)
 Catches exceptions generated in descendant components. Unhandled exceptions will cause
 the entire component tree to unmount.
@@ -375,7 +376,7 @@ React.Component.getSnapshotBeforeUpdate;
 render(): ReactNode;
 ```
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L70)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L71)
 #### Returns
@@ -604,7 +605,7 @@ React.Component.UNSAFE_componentWillUpdate;
 static getDerivedStateFromError(error): PlayErrorBoundaryState;
 ```
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L62)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L63)
 #### Parameters

package/api/@xmachines/play-react/functions/useActor.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function useActor(): AnyPlayActor;
 ```
-Defined in: [packages/play-react/src/useActor.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/useActor.ts#L32)
+Defined in: [packages/play-react/src/useActor.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useActor.ts#L34)
 ## Returns

package/api/@xmachines/play-react/functions/usePlayView.md CHANGED Viewed

@@ -6,11 +6,11 @@
 function usePlayView(): ViewContextValue;
 ```
-Defined in: [packages/play-react/src/ActorProvider.tsx:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L91)
+Defined in: [packages/play-react/src/ActorProvider.tsx:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L94)
-Hook to access the current view spec, handlers, and registry.
+The hook that gives the current view spec, the handlers, and the registry.
-Must be called inside <ActorProvider> or <PlayUIProvider>.
+Call it inside <ActorProvider> or <PlayUIProvider>.
 ## Returns
@@ -18,7 +18,7 @@ Must be called inside <ActorProvider> or <PlayUIProvider>.
 ## Throws
-If called outside an ActorProvider/PlayUIProvider tree
+When the caller is outside an ActorProvider or PlayUIProvider tree
 ## Example

package/api/@xmachines/play-react/functions/useSignalEffect.md CHANGED Viewed

@@ -6,33 +6,33 @@
 function useSignalEffect(callback, deps?): void;
 ```
-Defined in: [packages/play-react/src/useSignalEffect.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/useSignalEffect.ts#L80)
+Defined in: [packages/play-react/src/useSignalEffect.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useSignalEffect.ts#L81)
-React hook that subscribes to signal changes and runs effect callback
+The React hook that subscribes to the signal changes and runs an effect callback
-Wraps the callback in a Signal.Computed to automatically track signal
-dependencies accessed inside it, then delegates the watcher lifecycle
-(microtask batching, re-arming, disposal) to `watchSignal` from
-`@xmachines/play-signals` — the single canonical implementation shared
-across framework renderers.
+The hook puts the callback in a Signal.Computed, which tracks each signal that
+the callback reads. It then gives the watcher lifecycle to `watchSignal` from
+`@xmachines/play-signals`. That function does the microtask batching, the new arm
+of the watcher, and the disposal. It is the one canonical implementation, and
+every framework renderer uses it.
 Architecture:
-- Uses Signal.Computed to wrap callback for automatic dependency tracking
-- watchSignal owns the Signal.subtle.Watcher lifecycle (Phase 29 memory safety)
-- Microtask batching coalesces rapid signal updates
-- Re-rendering is driven by the callback's own setState (see remarks)
-- Handles cleanup on unmount to prevent memory leaks
+- The hook puts the callback in a Signal.Computed for the dependency tracking
+- watchSignal owns the Signal.subtle.Watcher lifecycle (Phase 29, memory safety)
+- The microtask batching groups rapid signal updates
+- The callback triggers each new render with its own setState (see the remarks)
+- The hook cleans up on unmount, so that nothing stays in memory
-Invariant: Signal-Only Reactivity - Signals accessed in callback are watched.
-Invariant: Passive Infrastructure - React observes signals and does not control them.
+Invariant: Signal-Only Reactivity. The hook watches each signal that the callback reads.
+Invariant: Passive Infrastructure. React observes the signals, and it does not control them.
 ## Parameters
-| Parameter  | Type                           | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                            |
-| ---------- | ------------------------------ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `callback` | () => `void` \| (() => `void`) | `undefined`   | Effect function that accesses signals. Can return cleanup function.                                                                                                                                                                                                                                                                                                                                                    |
-| `deps`     | `DependencyList`               | `[]`          | Optional dependency list (like useEffect). When any dependency changes, the watcher and Computed are torn down and recreated, re-tracking signals from scratch. Defaults to `[]` (subscribe once per mount). Pass this when the identity of the object whose signals you read can change over the component's lifetime (e.g. an `actor` prop) — otherwise the watcher keeps tracking the OLD object's signals forever. |
+| Parameter  | Type                           | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| ---------- | ------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `callback` | () => `void` \| (() => `void`) | `undefined`   | The effect function that reads the signals. It can return a cleanup function.                                                                                                                                                                                                                                                                                                                                                                                                         |
+| `deps`     | `DependencyList`               | `[]`          | The optional dependency list, as in useEffect. On a change of one dependency, the hook removes the watcher and the Computed, then makes them again and tracks the signals from the start. The default is `[]`, which subscribes one time for each mount. Give this list when the identity of the object whose signals you read can change during the life of the component, for example an `actor` prop. Without the list, the watcher tracks the signals of the OLD object for ever. |
 ## Returns
@@ -44,34 +44,34 @@ Invariant: Passive Infrastructure - React observes signals and does not control
 const MyComponent = ({ actor }) => {
   const [view, setView] = useState(null);
-  // Subscribe to actor.currentView signal; re-subscribe if the actor swaps
+  // Subscribe to the actor.currentView signal, and subscribe again on a new actor
   useSignalEffect(() => {
     const currentView = actor.currentView.get();
     setView(currentView);
   }, [actor]);
-  return <div>{view?.component}</div>;
+  return <div>{view?.root}</div>;
 };
 ```
 ## Remarks
-**CRITICAL:** Signals must be accessed unconditionally (no if statements).
-Conditional signal access breaks automatic dependency tracking.
-**Performance:** Microtask batching (queueMicrotask, inside watchSignal)
-prevents React thrashing when multiple signals update rapidly.
-**Re-rendering:** the hook itself does NOT force a React render on signal
-change — the callback drives re-rendering by calling setState with the new
-signal value (as in the example above). This lets React's setState bailout
-skip renders when the derived value is unchanged; an unconditional
-force-update here previously caused a wasted render per notification even
-when the callback's setState bailed. If you need to re-render on every
-notification while reading signals during render, mirror the signal value
-into React state inside the callback.
-**Implementation note:** We wrap the callback in Signal.Computed because
-Signal.subtle.Watcher cannot automatically track arbitrary function calls.
-The Computed handles dependency tracking; watchSignal evaluates it (which
-runs the callback) whenever any tracked signal changes.
+**CRITICAL:** read each signal unconditionally, with no `if` statement. A
+conditional read breaks the dependency tracking.
+**Performance:** the microtask batching (queueMicrotask, inside watchSignal)
+stops a flood of React renders when several signals update in rapid sequence.
+**Re-rendering:** the hook itself does NOT force a React render on a signal
+change. The callback triggers each new render, because it calls setState with the
+new signal value, as in the example above. The setState bailout of React can
+therefore skip a render when the derived value is the same. An unconditional
+force-update here caused one wasted render for each notification before, also
+when the setState of the callback made the bailout. If you must render again on
+every notification, and you read the signals during the render, copy the signal
+value into the React state inside the callback.
+**Implementation note:** the hook puts the callback in a Signal.Computed, because
+Signal.subtle.Watcher cannot track an arbitrary function call. The Computed does
+the dependency tracking. watchSignal evaluates the Computed, which runs the
+callback, on each change of a tracked signal.

package/api/@xmachines/play-react/interfaces/ActorProviderProps.md CHANGED Viewed

@@ -2,9 +2,9 @@
 # Interface: ActorProviderProps
-Defined in: [packages/play-react/src/ActorProvider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L50)
+Defined in: [packages/play-react/src/ActorProvider.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L53)
-Props for the ActorProvider component.
+The props of the ActorProvider component.
 ## Extends
@@ -16,12 +16,12 @@ Props for the ActorProvider component.
 ## 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:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L156) |
-| <a id="property-children"></a> `children`             | `ReactNode`                                                                                                                                                                                                                                                      | Child components to render inside the provider tree                                                                                                                                                                         | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L56)   |
-| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                                                                                                                                                                                                                      | Optional component shown when currentView is null or a catalog component throws                                                                                                                                             | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L52)   |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `info`) => `void`                                                                                                                                                                                                                                      | Optional error handler callback invoked when a catalog component throws during render                                                                                                                                       | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L54)   |
-| <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:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L169) |
-| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | 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:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L158) |
-| <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:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L164) |
+| 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) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
+| <a id="property-children"></a> `children`             | `ReactNode`                                                                                                                                                                                                                                                      | The child components to render inside the provider tree                                                                                                                                                                                                                           | -                                                                                                                                                                                   | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L59)   |
+| <a id="property-fallback"></a> `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](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L55)   |
+| <a id="property-onerror"></a> `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](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L57)   |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
+| <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult`                                                                                                                                                                                                                                           | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
+| <a id="property-store"></a> `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`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |

package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md CHANGED Viewed

@@ -2,14 +2,14 @@
 # Interface: PlayErrorBoundaryProps
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L14)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L14)
-Props for PlayErrorBoundary
+The props of PlayErrorBoundary
 ## Properties
-| Property                                   | Type                        | Description                                                                             | Defined in                                                                                                                                                     |
-| ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-children"></a> `children`  | `ReactNode`                 | Child components to render                                                              | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
-| <a id="property-fallback"></a> `fallback?` | `ReactNode`                 | Fallback UI to render when a child component throws. Defaults to null.                  | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
-| <a id="property-onerror"></a> `onError?`   | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
+| Property                                   | Type                        | Description                                                                              | Defined in                                                                                                                                                     |
+| ------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-children"></a> `children`  | `ReactNode`                 | The child components to render                                                           | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
+| <a id="property-fallback"></a> `fallback?` | `ReactNode`                 | The fallback UI to render when a child component throws. The default is null.            | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
+| <a id="property-onerror"></a> `onError?`   | (`error`, `info`) => `void` | The optional error handler. It sends each error to an observability tool, such as Sentry | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |

package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md CHANGED Viewed

@@ -2,13 +2,13 @@
 # Interface: PlayErrorBoundaryState
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L28)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L28)
-Internal state shape for PlayErrorBoundary
+The internal state shape of PlayErrorBoundary
 ## Properties
 | Property                                  | Type              | Defined in                                                                                                                                                     |
 | ----------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-error"></a> `error`       | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
-| <a id="property-haserror"></a> `hasError` | `boolean`         | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
+| <a id="property-error"></a> `error`       | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
+| <a id="property-haserror"></a> `hasError` | `boolean`         | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L29) |

package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md CHANGED Viewed

@@ -2,9 +2,9 @@
 # Interface: PlayUIProviderProps
-Defined in: [packages/play-react/src/PlayUIProvider.tsx:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayUIProvider.tsx#L34)
+Defined in: [packages/play-react/src/PlayUIProvider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayUIProvider.tsx#L35)
-Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own props.
+The props of PlayUIProvider — every ActorProvider prop, and also the props of JSONUIProvider.
 ## Extends
@@ -12,15 +12,15 @@ Props for PlayUIProvider — all ActorProvider props plus JSONUIProvider's own p
 ## 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:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L156) |
-| <a id="property-children"></a> `children`                        | `ReactNode`                                                                                                                                                                                                                                                      | Child components to render inside the provider tree                                                                                                                                                                         | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children)                          | [packages/play-react/src/ActorProvider.tsx:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L56)   |
-| <a id="property-fallback"></a> `fallback?`                       | `ReactNode`                                                                                                                                                                                                                                                      | Optional component shown when currentView is null or a catalog component throws                                                                                                                                             | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback)                          | [packages/play-react/src/ActorProvider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L52)   |
-| <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`, `info`) => `void`                                                                                                                                                                                                                                      | Optional error handler callback invoked when a catalog component throws during render                                                                                                                                       | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror)                            | [packages/play-react/src/ActorProvider.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L54)   |
-| <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:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L169) |
-| <a id="property-registryresult"></a> `registryResult`            | `DefineRegistryResult`                                                                                                                                                                                                                                           | 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:158](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L158) |
-| <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:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L164) |
-| <a id="property-validationfunctions"></a> `validationFunctions?` | `Record`\<`string`, (`value`, `args?`) => `boolean`\>                                                                                                                                                                                                            | Custom validation functions                                                                                                                                                                                                 | [`JSONUIProviderProps`](JSONUIProviderProps.md).[`validationFunctions`](JSONUIProviderProps.md#property-validationfunctions) | -                                                                                                                                                        |
+| 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) | The actor instance with the currentView signal. It requires the Viewable capability.                                                                                                                                                                                              | [`ActorProviderProps`](ActorProviderProps.md).[`actor`](ActorProviderProps.md#property-actor)                                | [packages/play-actor/src/abstract-actor.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L163) |
+| <a id="property-children"></a> `children`                        | `ReactNode`                                                                                                                                                                                                                                                      | The child components to render inside the provider tree                                                                                                                                                                                                                           | [`ActorProviderProps`](ActorProviderProps.md).[`children`](ActorProviderProps.md#property-children)                          | [packages/play-react/src/ActorProvider.tsx:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L59)   |
+| <a id="property-fallback"></a> `fallback?`                       | `ReactNode`                                                                                                                                                                                                                                                      | The component to show when currentView is null, or when a catalog component throws. This prop is optional                                                                                                                                                                         | [`ActorProviderProps`](ActorProviderProps.md).[`fallback`](ActorProviderProps.md#property-fallback)                          | [packages/play-react/src/ActorProvider.tsx:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L55)   |
+| <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`, `info`) => `void`                                                                                                                                                                                                                                      | The optional error handler. The provider calls it when a catalog component throws during a render                                                                                                                                                                                 | [`ActorProviderProps`](ActorProviderProps.md).[`onError`](ActorProviderProps.md#property-onerror)                            | [packages/play-react/src/ActorProvider.tsx:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L57)   |
+| <a id="property-onrendererror"></a> `onRenderError?`             | [`RenderErrorHandler`](../type-aliases/RenderErrorHandler.md)                                                                                                                                                                                                    | The provider calls it when one catalog component throws during a render. This handler replaces every onRenderError of defineRegistry.                                                                                                                                             | [`ActorProviderProps`](ActorProviderProps.md).[`onRenderError`](ActorProviderProps.md#property-onrendererror)                | [packages/play-actor/src/abstract-actor.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L177) |
+| <a id="property-registryresult"></a> `registryResult`            | `DefineRegistryResult`                                                                                                                                                                                                                                           | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                  | [`ActorProviderProps`](ActorProviderProps.md).[`registryResult`](ActorProviderProps.md#property-registryresult)              | [packages/play-actor/src/abstract-actor.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L165) |
+| <a id="property-store"></a> `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`](ActorProviderProps.md).[`store`](ActorProviderProps.md#property-store)                                | [packages/play-actor/src/abstract-actor.ts:172](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L172) |
+| <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-react/interfaces/ViewContextValue.md CHANGED Viewed

@@ -2,9 +2,9 @@
 # Interface: ViewContextValue
-Defined in: [packages/play-react/src/ActorProvider.tsx:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L64)
+Defined in: [packages/play-react/src/ActorProvider.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L67)
-Value provided by ViewContext (accessible via usePlayView()).
+The value that ViewContext provides. usePlayView() reads it.
 ## Extends
@@ -12,9 +12,9 @@ Value provided by ViewContext (accessible via usePlayView()).
 ## 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:124](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L124) |
-| <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:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L126) |
-| <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:122](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L122) |
-| <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:128](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-actor/src/abstract-actor.ts#L128) |
+| Property                                  | Type                                                  | Description                                                                                                            | Inherited from                                                                                                                                                    | Defined in                                                                                                                                               |
+| ----------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-handlers"></a> `handlers` | `Record`\<`string`, `ActionHandler`\>                 | The 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/v2.1.0/packages/play-actor/src/abstract-actor.ts#L127) |
+| <a id="property-registry"></a> `registry` | `TRegistry`                                           | The 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/v2.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/v2.1.0/packages/play-actor/src/abstract-actor.ts#L125) |
+| <a id="property-store"></a> `store`       | `StateStore`                                          | The active StateStore. Give it to JSONUIProvider or JsonUIProvider as `store`, and the providers then share the state. | [`BaseViewContextValue`](../../play-actor/interfaces/BaseViewContextValue.md).[`store`](../../play-actor/interfaces/BaseViewContextValue.md#property-store)       | [packages/play-actor/src/abstract-actor.ts:133](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-actor/src/abstract-actor.ts#L133) |

package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md CHANGED Viewed

@@ -6,6 +6,6 @@
 type AnyPlayActor = AbstractActor<AnyActorLogic>;
 ```
-Defined in: [packages/play-react/src/useActor.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/useActor.ts#L28)
+Defined in: [packages/play-react/src/useActor.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/useActor.ts#L30)
-Bare actor type accepted by React context providers. For the full routing + view shape, use `PlayActor` from `@xmachines/play-router`.
+The bare actor type that the React context providers accept. For the complete routing and view shape, use `PlayActor` from `@xmachines/play-router`.

package/api/@xmachines/play-react/type-aliases/PlayRendererProps.md ADDED Viewed

@@ -0,0 +1,13 @@
+[API](../../../README.md) / [@xmachines/play-react](../README.md) / PlayRendererProps
+# ~~Type Alias: PlayRendererProps~~
+```ts
+type PlayRendererProps = ActorProviderProps;
+```
+Defined in: [packages/play-react/src/index.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/index.ts#L71)
+## Deprecated
+Use [ActorProviderProps](../interfaces/ActorProviderProps.md). Will be removed in the next major.

package/api/@xmachines/play-react/variables/ActorProvider.md CHANGED Viewed

@@ -6,27 +6,28 @@
 const ActorProvider: React.FC<ActorProviderProps>;
 ```
-Defined in: [packages/play-react/src/ActorProvider.tsx:193](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/ActorProvider.tsx#L193)
+Defined in: [packages/play-react/src/ActorProvider.tsx:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/ActorProvider.tsx#L202)
-ActorProvider — escape hatch primitive for composing actor lifecycle with custom providers.
+ActorProvider — the low-level provider that composes the actor lifecycle with your own providers.
-Subscribes to actor.currentView signal, manages the per-view StateStore lifecycle,
-wraps children in StateProvider and PlayErrorBoundary, and injects onRenderError
-into the component registry.
+It subscribes to the actor.currentView signal. It manages the StateStore
+lifecycle of each view. It wraps the children in StateProvider and in
+PlayErrorBoundary. It also puts onRenderError into the component registry.
-Standard usage: prefer <PlayUIProvider> unless you need to compose providers manually.
+Standard use: prefer <PlayUIProvider>, and use this component only when you
+compose the providers yourself.
 ## Example
 ```tsx
-// Custom composition (escape hatch):
+// A custom composition:
 <ActorProvider actor={actor} registryResult={registryResult}>
   <JSONUIProvider registry={registryResult.registry}>
     <PlayRenderer />
   </JSONUIProvider>
 </ActorProvider>
-// Standard usage: prefer PlayUIProvider
+// Standard use: prefer PlayUIProvider
 <PlayUIProvider actor={actor} registryResult={registryResult}>
   <PlayRenderer />
 </PlayUIProvider>

package/api/@xmachines/play-react/variables/PlayRenderer.md CHANGED Viewed

@@ -6,9 +6,10 @@
 const PlayRenderer: React.FC<Record<string, never>>;
 ```
-Defined in: [packages/play-react/src/PlayRenderer.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayRenderer.tsx#L39)
+Defined in: [packages/play-react/src/PlayRenderer.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayRenderer.tsx#L40)
-Zero-prop leaf component that renders the current actor view.
+The leaf component without props that renders the current actor view.
-Reads the current PlaySpec, handlers, and registry from the ActorProvider
-context via usePlayView(), then renders via @xmachines/json-render-react Renderer.
+It reads the current PlaySpec, the handlers, and the registry from the
+ActorProvider context with usePlayView(). It then renders them with the Renderer
+of @xmachines/json-render-react.

package/api/@xmachines/play-react/variables/PlayUIProvider.md CHANGED Viewed

@@ -6,13 +6,13 @@
 const PlayUIProvider: React.FC<PlayUIProviderProps>;
 ```
-Defined in: [packages/play-react/src/PlayUIProvider.tsx:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0/packages/play-react/src/PlayUIProvider.tsx#L102)
+Defined in: [packages/play-react/src/PlayUIProvider.tsx:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.1.0/packages/play-react/src/PlayUIProvider.tsx#L106)
-PlayUIProvider — batteries-included entry point for actor-driven UI rendering.
+PlayUIProvider — the standard entry point for an actor-driven UI.
-Combines actor lifecycle management (ActorProvider) with full UI provider setup
-(JSONUIProvider including ActionProvider, ValidationProvider, VisibilityProvider,
-StateProvider, and ConfirmDialogManager).
+It joins the actor lifecycle (ActorProvider) with the complete UI provider setup
+(JSONUIProvider, which holds ActionProvider, ValidationProvider,
+VisibilityProvider, StateProvider, and ConfirmDialogManager).
 ## Example
@@ -31,7 +31,7 @@ const registryResult = defineRegistry(catalog, {
   <PlayRenderer />
 </PlayUIProvider>
-// With JSONUIProvider options:
+// With the options of JSONUIProvider:
 <PlayUIProvider
   actor={actor}
   registryResult={registryResult}