@xmachines/docs 7.0.0 → 7.1.0

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

@@ -2,7 +2,7 @@
 
 # Class: PlayErrorBoundary
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L99)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L99)
 
 The React class component that catches a render error of a catalog component.
 
@@ -37,7 +37,7 @@ CONS-14: the class component pattern works with every React version, 18 and 19.
 new PlayErrorBoundary(props): PlayErrorBoundary;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L103)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L103)
 
 #### Parameters
 
@@ -51,12 +51,7 @@ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:103](https://gitlab.c
 
 #### Overrides
 
-```ts
-React.Component<
-	PlayErrorBoundaryProps,
-	PlayErrorBoundaryState
->.constructor
-```
+`React.Component<PlayErrorBoundaryProps, 	PlayErrorBoundaryState>.constructor`
 
 ## Properties
 
@@ -76,7 +71,7 @@ React.Component<
 componentDidCatch(error, info): void;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L135)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L135)
 
 Catches exceptions generated in descendant components. Unhandled exceptions will cause
 the entire component tree to unmount.
@@ -94,16 +89,14 @@ the entire component tree to unmount.
 
 #### Overrides
 
-```ts
-React.Component.componentDidCatch;
-```
+`React.Component.componentDidCatch`
 
 ---
 
 ### componentDidMount()?
 
 ```ts
-optional componentDidMount(): void;
+componentDidMount?(): void;
 ```
 
 Defined in: `@types/react`
@@ -116,16 +109,14 @@ Called immediately after a component is mounted. Setting state here will trigger
 
 #### Inherited from
 
-```ts
-React.Component.componentDidMount;
-```
+`React.Component.componentDidMount`
 
 ---
 
 ### componentDidUpdate()?
 
 ```ts
-optional componentDidUpdate(
+componentDidUpdate?(
    prevProps,
    prevState,
    snapshot?
@@ -152,16 +143,14 @@ The snapshot is only present if [getSnapshotBeforeUpdate](#getsnapshotbeforeupda
 
 #### Inherited from
 
-```ts
-React.Component.componentDidUpdate;
-```
+`React.Component.componentDidUpdate`
 
 ---
 
 ### ~~componentWillMount()?~~
 
 ```ts
-optional componentWillMount(): void;
+componentWillMount?(): void;
 ```
 
 Defined in: `@types/react`
@@ -188,16 +177,14 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.componentWillMount;
-```
+`React.Component.componentWillMount`
 
 ---
 
 ### ~~componentWillReceiveProps()?~~
 
 ```ts
-optional componentWillReceiveProps(nextProps, nextContext): void;
+componentWillReceiveProps?(nextProps, nextContext): void;
 ```
 
 Defined in: `@types/react`
@@ -234,16 +221,14 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.componentWillReceiveProps;
-```
+`React.Component.componentWillReceiveProps`
 
 ---
 
 ### componentWillUnmount()?
 
 ```ts
-optional componentWillUnmount(): void;
+componentWillUnmount?(): void;
 ```
 
 Defined in: `@types/react`
@@ -257,16 +242,14 @@ cancelled network requests, or cleaning up any DOM elements created in `componen
 
 #### Inherited from
 
-```ts
-React.Component.componentWillUnmount;
-```
+`React.Component.componentWillUnmount`
 
 ---
 
 ### ~~componentWillUpdate()?~~
 
 ```ts
-optional componentWillUpdate(
+componentWillUpdate?(
    nextProps,
    nextState,
    nextContext
@@ -306,9 +289,7 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.componentWillUpdate;
-```
+`React.Component.componentWillUpdate`
 
 ---
 
@@ -332,16 +313,14 @@ Defined in: `@types/react`
 
 #### Inherited from
 
-```ts
-React.Component.forceUpdate;
-```
+`React.Component.forceUpdate`
 
 ---
 
 ### getSnapshotBeforeUpdate()?
 
 ```ts
-optional getSnapshotBeforeUpdate(prevProps, prevState): any;
+getSnapshotBeforeUpdate ? (prevProps, prevState) : any;
 ```
 
 Defined in: `@types/react`
@@ -366,9 +345,7 @@ lifecycle events from running.
 
 #### Inherited from
 
-```ts
-React.Component.getSnapshotBeforeUpdate;
-```
+`React.Component.getSnapshotBeforeUpdate`
 
 ---
 
@@ -378,7 +355,7 @@ React.Component.getSnapshotBeforeUpdate;
 render(): ReactNode;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L139)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L139)
 
 #### Returns
 
@@ -386,9 +363,7 @@ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:139](https://gitlab.c
 
 #### Overrides
 
-```ts
-React.Component.render;
-```
+`React.Component.render`
 
 ---
 
@@ -402,9 +377,9 @@ Defined in: `@types/react`
 
 #### Type Parameters
 
-| Type Parameter                                                                          |
-| --------------------------------------------------------------------------------------- |
-| `K` _extends_ keyof [`PlayErrorBoundaryState`](../interfaces/PlayErrorBoundaryState.md) |
+| Type Parameter                                                                                                        |
+| --------------------------------------------------------------------------------------------------------------------- |
+| <a id="type-parameter-k"></a> `K` _extends_ keyof [`PlayErrorBoundaryState`](../interfaces/PlayErrorBoundaryState.md) |
 
 #### Parameters
 
@@ -419,20 +394,14 @@ Defined in: `@types/react`
 
 #### Inherited from
 
-```ts
-React.Component.setState;
-```
+`React.Component.setState`
 
 ---
 
 ### shouldComponentUpdate()?
 
 ```ts
-optional shouldComponentUpdate(
-   nextProps,
-   nextState,
-   nextContext
-): boolean;
+shouldComponentUpdate ? (nextProps, nextState, nextContext) : boolean;
 ```
 
 Defined in: `@types/react`
@@ -460,16 +429,14 @@ and `componentDidUpdate` will not be called.
 
 #### Inherited from
 
-```ts
-React.Component.shouldComponentUpdate;
-```
+`React.Component.shouldComponentUpdate`
 
 ---
 
 ### ~~UNSAFE\_componentWillMount()?~~
 
 ```ts
-optional UNSAFE_componentWillMount(): void;
+UNSAFE_componentWillMount?(): void;
 ```
 
 Defined in: `@types/react`
@@ -498,16 +465,14 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.UNSAFE_componentWillMount;
-```
+`React.Component.UNSAFE_componentWillMount`
 
 ---
 
 ### ~~UNSAFE\_componentWillReceiveProps()?~~
 
 ```ts
-optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void;
+UNSAFE_componentWillReceiveProps?(nextProps, nextContext): void;
 ```
 
 Defined in: `@types/react`
@@ -546,16 +511,14 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.UNSAFE_componentWillReceiveProps;
-```
+`React.Component.UNSAFE_componentWillReceiveProps`
 
 ---
 
 ### ~~UNSAFE\_componentWillUpdate()?~~
 
 ```ts
-optional UNSAFE_componentWillUpdate(
+UNSAFE_componentWillUpdate?(
    nextProps,
    nextState,
    nextContext
@@ -597,9 +560,7 @@ this from being invoked.
 
 #### Inherited from
 
-```ts
-React.Component.UNSAFE_componentWillUpdate;
-```
+`React.Component.UNSAFE_componentWillUpdate`
 
 ---
 
@@ -609,7 +570,7 @@ React.Component.UNSAFE_componentWillUpdate;
 static getDerivedStateFromError(error): Pick<PlayErrorBoundaryState, "hasError" | "error">;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L108)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:108](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L108)
 
 #### Parameters
 
@@ -631,7 +592,7 @@ static getDerivedStateFromProps(props, state):
   | null;
 ```
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L126)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:126](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L126)
 
 Clears the error state after a change of `resetKey`.
 

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

@@ -14,9 +14,9 @@ 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`\> |
+| Type Parameter                                                                                                                                                     |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="type-parameter-c"></a> `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
 
 ## Parameters
 

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

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

package/api/@xmachines/play-react/functions/useAtomEffect.md

@@ -6,7 +6,7 @@
 function useAtomEffect(sources, callback, deps?): void;
 ```
 
-Defined in: [packages/play-react/src/useAtomEffect.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/useAtomEffect.ts#L106)
+Defined in: [packages/play-react/src/useAtomEffect.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/useAtomEffect.ts#L106)
 
 The React hook that subscribes to the named atoms and runs an effect callback
 
@@ -32,7 +32,7 @@ Invariant: Passive Infrastructure. React observes the atoms, and it does not con
 | ---------- | ---------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `sources`  | readonly [`Readable`](../../play-atom/interfaces/Readable.md)\<`unknown`\>[] | `undefined`   | The atoms that run the effect. The list names every dependency, and the reads of the callback name none: a callback that reads a view store therefore depends on that store not, and a write of the store runs the effect never.                                                                                                                                                                                                                                                      |
 | `callback` | () => `void` \| (() => `void`)                                               | `undefined`   | The effect function. It can return a cleanup function. It runs one time on the mount, and one time for each write of a source.                                                                                                                                                                                                                                                                                                                                                        |
-| `deps`     | `DependencyList`                                                             | `[]`          | The optional dependency list, as in useEffect. On a change of one dependency, the hook removes the watcher and the computed atom, then makes them again and reads the sources from the start. The default is `[]`, which subscribes one time for each mount. Give this list when the identity of the object whose atoms you read can change during the life of the component, for example an `actor` prop. Without the list, the watcher tracks the atoms of the OLD object for ever. |
+| `deps?`    | `DependencyList`                                                             | `[]`          | The optional dependency list, as in useEffect. On a change of one dependency, the hook removes the watcher and the computed atom, then makes them again and reads the sources from the start. The default is `[]`, which subscribes one time for each mount. Give this list when the identity of the object whose atoms you read can change during the life of the component, for example an `actor` prop. Without the list, the watcher tracks the atoms of the OLD object for ever. |
 
 ## Returns
 

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

@@ -18,9 +18,9 @@ a prop uses `{ $bindState: "/path" }` or `{ $bindItem: "field" }`.
 
 ## Type Parameters
 
-| Type Parameter |
-| -------------- |
-| `T`            |
+| Type Parameter                    |
+| --------------------------------- |
+| <a id="type-parameter-t"></a> `T` |
 
 ## Parameters
 

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

@@ -6,7 +6,7 @@
 function usePlayView(): ViewContextValue;
 ```
 
-Defined in: [packages/play-react/src/ActorProvider.tsx:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/ActorProvider.tsx#L147)
+Defined in: [packages/play-react/src/ActorProvider.tsx:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/ActorProvider.tsx#L147)
 
 The hook that gives the current view spec, the handlers, and the registry.
 

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

@@ -2,7 +2,7 @@
 
 # Interface: ActorProviderProps
 
-Defined in: [packages/play-react/src/ActorProvider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/ActorProvider.tsx#L52)
+Defined in: [packages/play-react/src/ActorProvider.tsx:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/ActorProvider.tsx#L52)
 
 The props of the ActorProvider component.
 
@@ -16,12 +16,12 @@ The props of the ActorProvider component.
 
 ## Properties
 
-| Property                                              | Type                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                                                                | Defined in                                                                                                                                             |
-| ----------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-actor"></a> `actor`                   | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`actor`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L219)         |
-| <a id="property-children"></a> `children`             | `ReactNode`                                                    | The child components to render inside the provider tree                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/ActorProvider.tsx#L95) |
-| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                    | The component to show when currentView is null, or after a failure of the view. This prop is optional                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/ActorProvider.tsx#L54) |
-| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`, `info`) => `void`                           | The optional error handler. The provider calls it when a descendant throws during a render. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The SECOND parameter is the reset, for a retry that the host starts — a "Retry" button of its own. It sits in the same place as in the four other renderers, and the `React.ErrorInfo` of the boundary comes third. The reset clears the contained error and renders again. It renders the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler does nothing, because no input changed between the two attempts, and a reset after the provider is unmounted does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. This handler runs inside `componentDidCatch`, so a throw that left it would reach the boundary ABOVE this provider, and React can then unmount the complete root — which is the failure that this boundary contained. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/ActorProvider.tsx#L93) |
-| <a id="property-onrendererror"></a> `onRenderError?`  | [`OnRenderError`](../type-aliases/OnRenderError.md)            | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L236)         |
-| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md)              | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L221)         |
-| <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-view/index/interfaces/BaseActorProviderProps.md).[`store`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-view/src/view-types.ts#L228)         |
+| Property                                              | Type                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Inherited from                                                                                                                                                                                | Defined in                                                                                                                                                  |
+| ----------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                   | [`ViewActor`](../../play-view/index/type-aliases/ViewActor.md) | The actor instance with the currentView atom. It requires the Viewable capability.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`actor`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-actor)                   | [packages/play-view/src/view-types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-view/src/view-types.ts#L219)         |
+| <a id="property-children"></a> `children`             | `ReactNode`                                                    | The child components to render inside the provider tree                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:95](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/ActorProvider.tsx#L95) |
+| <a id="property-fallback"></a> `fallback?`            | `ReactNode`                                                    | The component to show when currentView is null, or after a failure of the view. This prop is optional                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/ActorProvider.tsx#L54) |
+| <a id="property-onerror"></a> `onError?`              | (`error`, `reset`, `info`) => `void`                           | The optional error handler. The provider calls it when a descendant throws during a render. While the error is active, the provider renders the `fallback` instead of its children. The provider clears the error on the next view emission (when `currentView` changes), so a view transition retries the render. The per-element boundary of `json-render` catches a throw of a catalog component below the root, and it reports it through `onRenderError` alone. A failure of the ROOT — its component, a prop, or its `visible` condition — leaves no view, and json-render gives it to no boundary of the host. The provider contains it as a failure of the view all the same: it shows the fallback, and it calls this handler one time. `onRenderError` also receives it, with `info.kind` `"root"`. This boundary is the outer net for everything else. The SECOND parameter is the reset, for a retry that the host starts — a "Retry" button of its own. It sits in the same place as in the four other renderers, and the `React.ErrorInfo` of the boundary comes third. The reset clears the contained error and renders again. It renders the view that the actor holds at the MOMENT OF THE CALL, so a host that keeps the callback cannot rewind the screen to the view that failed. A reset that the host calls from inside this handler does nothing, because no input changed between the two attempts, and a reset after the provider is unmounted does nothing. The five renderers hold the same three rules. **A handler that THROWS reaches no caller.** The provider contains that throw, and it writes the throw to `console.error`. This handler runs inside `componentDidCatch`, so a throw that left it would reach the boundary ABOVE this provider, and React can then unmount the complete root — which is the failure that this boundary contained. Report a failure from this handler. To ESCALATE one, raise it from a task of your own — `rethrowLater(error)` of `@xmachines/core/utils` — which reaches the global handler of the page and leaves the containment whole. The host installs `@xmachines/core` itself. The five renderers hold this one rule. | -                                                                                                                                                                                             | [packages/play-react/src/ActorProvider.tsx:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/ActorProvider.tsx#L93) |
+| <a id="property-onrendererror"></a> `onRenderError?`  | [`OnRenderError`](../type-aliases/OnRenderError.md)            | The renderer calls it with `(error, name, info)` for each failure that it reports: a catalog component that throws, a prop or a `visible` condition that fails, an action chain or a watch chain that fails, and a failure of the root. `info.kind` names the kind of the failure. A handler with the two parameters `(error, name)` stays valid. This handler replaces every onRenderError of defineRegistry.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-onrendererror)   | [packages/play-view/src/view-types.ts:236](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-view/src/view-types.ts#L236)         |
+| <a id="property-registryresult"></a> `registryResult` | [`DefineRegistryResult`](DefineRegistryResult.md)              | The complete result of defineRegistry(). It holds the component registry and the factory of the action handlers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [`BaseActorProviderProps`](../../play-view/index/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-view/src/view-types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-view/src/view-types.ts#L221)         |
+| <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-view/index/interfaces/BaseActorProviderProps.md).[`store`](../../play-view/index/interfaces/BaseActorProviderProps.md#property-store)                   | [packages/play-view/src/view-types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-view/src/view-types.ts#L228)         |

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

@@ -20,10 +20,10 @@ const Button: ComponentFn<typeof catalog, 'Button'> = (ctx) => {
 
 ## Type Parameters
 
-| Type Parameter                                      |
-| --------------------------------------------------- |
-| `C` _extends_ `Catalog`                             |
-| `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
+| Type Parameter                                                                    |
+| --------------------------------------------------------------------------------- |
+| <a id="type-parameter-c"></a> `C` _extends_ `Catalog`                             |
+| <a id="type-parameter-k"></a> `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
 
 ## Properties
 

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

@@ -2,16 +2,16 @@
 
 # Interface: PlayErrorBoundaryProps
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.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/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L14)
 
 The props of PlayErrorBoundary
 
 ## Properties
 
-| 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/v7.0.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/v7.0.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/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
-| <a id="property-resetkey"></a> `resetKey?`             | `unknown`                         | The reset key. The boundary clears its error state when this value changes, and it renders the children again. ActorProvider gives it the current view. A view transition therefore retries the render. Without the key the boundary holds the fallback for the complete life of the provider: the user sends a recovery event, the actor moves to a healthy view, and the screen keeps the fallback. **The boundary compares the value by IDENTITY (`Object.is`) by default.** Give a stable reference. An inline object literal — `resetKey={{ view }}` — is a new value on every render, so the boundary clears its caught error before each one, renders the children that threw, catches again, and calls `onError` again. Hold the value where it survives a render, and build a new one only when an input moves. [PlayErrorBoundaryProps.resetKeyEquals](#property-resetkeyequals) takes the identity rule away, and a caller that gives one needs no stable reference at all. | [packages/play-react/src/PlayErrorBoundary.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L39) |
-| <a id="property-resetkeyequals"></a> `resetKeyEquals?` | (`previous`, `next`) => `boolean` | The comparison of two reset keys. The default is `Object.is`. The boundary clears its error where this function answers `false`. A caller that builds a key of several inputs therefore compares those INPUTS, and it owes the boundary no stable reference for the key that carries them. That is what `ActorProvider` gives. A key of the three view inputs and the retry nonce holds no identity of its own across renders — React makes no promise to keep a `useMemo`, and a ref that the render writes survives a render that React throws away, which the documentation of React forbids for that reason. With a comparison of the fields, a key that carries the same inputs is the same key, whichever render built it. The state of this class is the key of the last COMMIT: React commits the state of a class with the commit, so a render that React discards writes none. The comparison therefore reads the committed key on one side every time.                      | [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L63) |
+| 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/docs-v7.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/docs-v7.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/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
+| <a id="property-resetkey"></a> `resetKey?`             | `unknown`                         | The reset key. The boundary clears its error state when this value changes, and it renders the children again. ActorProvider gives it the current view. A view transition therefore retries the render. Without the key the boundary holds the fallback for the complete life of the provider: the user sends a recovery event, the actor moves to a healthy view, and the screen keeps the fallback. **The boundary compares the value by IDENTITY (`Object.is`) by default.** Give a stable reference. An inline object literal — `resetKey={{ view }}` — is a new value on every render, so the boundary clears its caught error before each one, renders the children that threw, catches again, and calls `onError` again. Hold the value where it survives a render, and build a new one only when an input moves. [PlayErrorBoundaryProps.resetKeyEquals](#property-resetkeyequals) takes the identity rule away, and a caller that gives one needs no stable reference at all. | [packages/play-react/src/PlayErrorBoundary.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L39) |
+| <a id="property-resetkeyequals"></a> `resetKeyEquals?` | (`previous`, `next`) => `boolean` | The comparison of two reset keys. The default is `Object.is`. The boundary clears its error where this function answers `false`. A caller that builds a key of several inputs therefore compares those INPUTS, and it owes the boundary no stable reference for the key that carries them. That is what `ActorProvider` gives. A key of the three view inputs and the retry nonce holds no identity of its own across renders — React makes no promise to keep a `useMemo`, and a ref that the render writes survives a render that React throws away, which the documentation of React forbids for that reason. With a comparison of the fields, a key that carries the same inputs is the same key, whichever render built it. The state of this class is the key of the last COMMIT: React commits the state of a class with the commit, so a render that React discards writes none. The comparison therefore reads the committed key on one side every time.                      | [packages/play-react/src/PlayErrorBoundary.tsx:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L63) |

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

@@ -2,14 +2,14 @@
 
 # Interface: PlayErrorBoundaryState
 
-Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L71)
+Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L71)
 
 The internal state shape of PlayErrorBoundary
 
 ## Properties
 
-| Property                                  | Type              | Description                                                               | Defined in                                                                                                                                                     |
-| ----------------------------------------- | ----------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-error"></a> `error`       | `Error` \| `null` | -                                                                         | [packages/play-react/src/PlayErrorBoundary.tsx:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L73) |
-| <a id="property-haserror"></a> `hasError` | `boolean`         | -                                                                         | [packages/play-react/src/PlayErrorBoundary.tsx:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L72) |
-| <a id="property-resetkey"></a> `resetKey` | `unknown`         | The resetKey of the last render. A different prop clears the error state. | [packages/play-react/src/PlayErrorBoundary.tsx:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v7.0.0/packages/play-react/src/PlayErrorBoundary.tsx#L75) |
+| Property                                  | Type              | Description                                                               | Defined in                                                                                                                                                          |
+| ----------------------------------------- | ----------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-error"></a> `error`       | `Error` \| `null` | -                                                                         | [packages/play-react/src/PlayErrorBoundary.tsx:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L73) |
+| <a id="property-haserror"></a> `hasError` | `boolean`         | -                                                                         | [packages/play-react/src/PlayErrorBoundary.tsx:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L72) |
+| <a id="property-resetkey"></a> `resetKey` | `unknown`         | The resetKey of the last render. A different prop clears the error state. | [packages/play-react/src/PlayErrorBoundary.tsx:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-react/src/PlayErrorBoundary.tsx#L75) |