@xmachines/docs 6.1.0 → 7.1.0

package/examples/@xmachines/play-react-demo/README.md

@@ -1,163 +0,0 @@
-[Examples](../../README.md) / @xmachines/play-react-demo
-
-# @xmachines/play-react-demo
-
-React renderer demo for [`@xmachines/play-react`](../../../api/@xmachines/play-react/README.md) — actor + `PlayRenderer` without a router.
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## What This Demonstrates
-
-- Shared auth machine reused without framework-specific business logic
-- `PlayRenderer` rendering actor-projected views with a typed `defineRegistry` catalog
-- Auth machine states drive view switching via `auth.login` / `auth.logout` events only — no `play.route` routing
-- Canonical atoms lifecycle surfaced through React's rendering model
-- Non-browser invariant tests plus browser renderer coverage
-- Stately inspector attached at creation via `options.inspect` — the debug panel's **Show Inspector** button opens the live machine in its own window
-- json-render 0.20 showcase pages driven purely by spec:
-    - **Overview** — two data planes side by side: `/context/tasks` (machine context via the read-only `/context` projection; `repeat` + `key`, `$item`-filtered lists, per-row actions sending inspectable machine events) next to ephemeral store state (`pushState`/`removeState`/`setState` built-ins driving filter chips and toggles that survive context updates)
-    - **Stats** — nested repeats (`repeat.statePath: { $item: "members" }`) over `/context/teams`
-    - **Settings** — declarative field validation, the `validateForm` built-in, a confirm-gated `resetForm` host action, and `onSuccess`/`onError` chains
-    - **Contact** — a chained named action: submit validates, then routes home on success or writes `"$error.message"` to state on failure
-
-## Running the Demo
-
-From the repository root:
-
-```bash
-pnpm install
-pnpm --filter @xmachines/play-react-demo run dev
-```
-
-Then open `http://localhost:3001`.
-
-## Step-by-Step Code Flow
-
-Use this order to understand the implementation:
-
-1. `src/main.tsx` mounts `<App />`.
-2. `src/App.tsx` creates the page's inspector with `createDemoInspector()` and the actor at module scope via `definePlayer({ machine: authMachine, options: { inspect: inspector.inspect }, actor: compose(PlayerActor, withRouting, withView) })()` — both created once when the module is first evaluated.
-3. `defineRegistry(authCatalog, { components, actions })` builds the typed `registryResult` — real async action handlers dispatching to `actor.send()`.
-4. `<PlayUIProvider actor={actor} registryResult={registryResult}><PlayRenderer /></PlayUIProvider>` observes `actor.currentView` and renders the active spec.
-5. A `NavBar` component observes `actor` atoms directly for nav visibility.
-6. `<DebugPanel actor={actor} inspector={inspector} />` shows live state, auth status, and current route, plus the **Show Inspector** button.
-7. Browser tests in `test/browser/` validate startup and interaction behavior.
-
-```tsx
-// src/main.tsx (shape)
-createRoot(document.getElementById("root")!).render(<App />);
-```
-
-```tsx
-// src/App.tsx (shape)
-// Both actor and registryResult are module-scope singletons — created once,
-// never recreated, no useMemo needed inside the component.
-const inspector = createDemoInspector();
-const actor: AuthActor = definePlayer({
-	machine: authMachine,
-	options: { inspect: inspector.inspect },
-	actor: compose(PlayerActor, withRouting, withView),
-})();
-actor.start();
-
-const registryResult = defineRegistry(authCatalog, {
-	components: demoComponents, // one shared map — Home…NavBar plus the 0.20 Panel/Field/Button leaves
-	actions: createAuthActionHandlers(actor), // login/logout/route + task events + form actions
-});
-
-export function App() {
-	return (
-		<div className="demo-app" data-demo-shell>
-			<header className="demo-header">
-				<h1 className="demo-title">XMachines Play React Demo</h1>
-				<NavBar actor={actor} />
-			</header>
-			<main className="demo-content" data-demo-content>
-				<PlayUIProvider actor={actor} registryResult={registryResult}>
-					<PlayRenderer />
-				</PlayUIProvider>
-			</main>
-			<DebugPanel actor={actor} inspector={inspector} />
-		</div>
-	);
-}
-```
-
-## Key Files
-
-- `src/main.tsx` - React entry point that mounts `<App />`
-- `src/App.tsx` - actor lifecycle, registry construction, and `PlayUIProvider` + `PlayRenderer` composition
-- `src/catalog.ts` - catalog definition using `defineCatalog` from `@xmachines/json-render-core` with `@xmachines/json-render-react/schema`
-- `src/components/` - demo view components bound to catalog component keys (Home, Login, Dashboard, Profile, etc.)
-- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
-- `test/browser/renderer-demo.browser.test.tsx` - browser-mode renderer coverage
-
-## State Machine & Architecture Details
-
-The demo utilizes XMachines architectural invariants:
-
-1. **Actor Authority:** View components dispatch `auth.login` and `auth.logout` events to the actor. The actor evaluates guards and transitions — React never decides which view to render.
-2. **Passive Infrastructure:** `PlayRenderer` observes `actor.currentView` atoms only. It holds no business state and makes no routing decisions.
-3. **Atom-Only Reactivity:** The bridge leverages React's rendering model to react precisely when actor atoms update, without polluting the component tree with `useState` or `useEffect` for business logic.
-
-## Watcher Lifecycle and Cleanup Contract
-
-This demo follows the canonical watcher lifecycle used across all `@xmachines` framework adapters:
-
-1. The atom notifies the subscription, synchronously, from the `set` that changed it
-2. `watchAtom` queues one microtask, and it drops each duplicate notification of that batch
-3. The microtask reads the actor atoms and projects React render state
-
-One subscription lives for the whole watch, and no caller arms a watcher again. Cleanup is explicit: `actor.stop()` is called on component unmount via `useEffect`, and `PlayRenderer` handles internal watcher teardown natively.
-
-## Adapter Boundaries
-
-`PlayRenderer` and `defineRegistry` stay passive infrastructure. Business validity remains actor-owned. The registry maps catalog component keys to React component implementations — the actor owns which key is active. The demo intentionally omits URL routing to isolate the renderer contract.
-
-## Available Scripts
-
-These commands are defined in `package.json`:
-
-| Command                                                     | Description                                    |
-| ----------------------------------------------------------- | ---------------------------------------------- |
-| `pnpm --filter @xmachines/play-react-demo run dev`          | Start Vite dev server (http://localhost:3001/) |
-| `pnpm --filter @xmachines/play-react-demo run build`        | Build production bundle                        |
-| `pnpm --filter @xmachines/play-react-demo run preview`      | Preview built bundle                           |
-| `pnpm --filter @xmachines/play-react-demo run test`         | Run Vitest test suite                          |
-| `pnpm --filter @xmachines/play-react-demo run test:browser` | Run browser-focused Vitest suite               |
-
-## Learn More
-
-- [play-react](../../../api/@xmachines/play-react/README.md)
-- [React Router demo](../play-react-router-demo/README.md)
-- [Inspecting a Running Actor](../../../guides/inspector.md)
-
-## Type Aliases
-
-- [AuthCatalog](type-aliases/AuthCatalog.md)
-
-## Variables
-
-- [About](variables/About.md)
-- [authCatalog](variables/authCatalog.md)
-- [Button](variables/Button.md)
-- [Contact](variables/Contact.md)
-- [Dashboard](variables/Dashboard.md)
-- [DebugPanel](variables/DebugPanel.md)
-- [demoComponents](variables/demoComponents.md)
-- [Field](variables/Field.md)
-- [Home](variables/Home.md)
-- [Login](variables/Login.md)
-- [NavBar](variables/NavBar.md)
-- [NavBarView](variables/NavBarView.md)
-- [Navigation](variables/Navigation.md)
-- [Overview](variables/Overview.md)
-- [Panel](variables/Panel.md)
-- [Profile](variables/Profile.md)
-- [Settings](variables/Settings.md)
-- [Shell](variables/Shell.md)
-- [Stats](variables/Stats.md)
-
-## Functions
-
-- [createAuthActionHandlers](functions/createAuthActionHandlers.md)

package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md

@@ -1,35 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / createAuthActionHandlers
-
-# Function: createAuthActionHandlers()
-
-```ts
-function createAuthActionHandlers(actor): object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L48)
-
-Build the demo action handler map for one actor.
-
-Returned functions use the `(params, setState) => Promise<void>` shape every
-framework's `defineRegistry` accepts; spread the result into its `actions`.
-
-## Parameters
-
-| Parameter | Type        |
-| --------- | ----------- |
-| `actor`   | `AuthActor` |
-
-## Returns
-
-`object`
-
-| Name             | Type                                                    | Defined in                                                                                                                                                               |
-| ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `addTask()`      | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L65) |
-| `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L72) |
-| `login()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L50) |
-| `logout()`       | () => `Promise`\<`void`\>                               | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L54) |
-| `removeTask()`   | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L81) |
-| `resetForm()`    | (`params`, `setState`) => `Promise`\<`void`\>           | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L99) |
-| `route()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L55) |
-| `submitForm()`   | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-actor/examples/shared/src/actions.ts#L92) |

package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md

@@ -1,9 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / AuthCatalog
-
-# Type Alias: AuthCatalog
-
-```ts
-type AuthCatalog = typeof authCatalog;
-```
-
-Defined in: [packages/play-react/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/catalog.ts#L6)

package/examples/@xmachines/play-react-demo/variables/About.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / About
-
-# Variable: About
-
-```ts
-const About: ComponentFn<AuthCatalog, "About">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/About.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/About.tsx#L10)
-
-About — Public information page
-
-Uses ComponentFn<AuthCatalog, "About"> for catalog-typed props.
-NavBar handles the navigation — this component only renders content.

package/examples/@xmachines/play-react-demo/variables/Button.md

@@ -1,12 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Button
-
-# Variable: Button
-
-```ts
-const Button: ComponentFn<AuthCatalog, "Button">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Button.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Button.tsx#L8)
-
-Button — emits `press`; the spec's `on.press` binding decides what happens
-(a host action sending a machine event, or a built-in like setState).

package/examples/@xmachines/play-react-demo/variables/Contact.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Contact
-
-# Variable: Contact
-
-```ts
-const Contact: ComponentFn<AuthCatalog, "Contact">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Contact.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Contact.tsx#L10)
-
-Contact — Public contact page
-
-Uses ComponentFn<AuthCatalog, "Contact"> for catalog-typed props.
-NavBar handles the navigation — this component only renders content.

package/examples/@xmachines/play-react-demo/variables/Dashboard.md

@@ -1,15 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Dashboard
-
-# Variable: Dashboard
-
-```ts
-const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Dashboard.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Dashboard.tsx#L12)
-
-Dashboard — Protected authenticated home
-
-Uses ComponentFn<AuthCatalog, "Dashboard"> for catalog-typed props.
-Emits "logout" to trigger the auth.logout event via PlayRenderer actions map.
-NavBar handles the navigation — this component only handles auth actions.

package/examples/@xmachines/play-react-demo/variables/DebugPanel.md

@@ -1,16 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / DebugPanel
-
-# Variable: DebugPanel
-
-```ts
-const DebugPanel: FC<{
-	actor: AuthActor;
-	inspector: DemoInspector;
-}>;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/DebugPanel.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L12)
-
-DebugPanel — Live debug footer. Observes actor.state and actor.currentRoute
-via useAtomEffect and displays current state value, can-logout status,
-and active route, plus the button that opens the Stately inspector window.

package/examples/@xmachines/play-react-demo/variables/Field.md

@@ -1,18 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Field
-
-# Variable: Field
-
-```ts
-const Field: ComponentFn<AuthCatalog, "Field">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Field.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Field.tsx#L15)
-
-Field — labelled input with two-way $bindState binding and declarative
-validation checks.
-
-Registration happens by rendering: useFieldValidation registers the bound
-state path with the ValidationProvider so the `validateForm` built-in sees
-it. The error DISPLAY deliberately reads `props.formErrors` — the result
-object validateForm wrote to state — rather than the local hook, so every
-renderer (DOM included) surfaces errors at the same moment: after submit.

package/examples/@xmachines/play-react-demo/variables/Home.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Home
-
-# Variable: Home
-
-```ts
-const Home: ComponentFn<AuthCatalog, "Home">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Home.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Home.tsx#L10)
-
-Home - Public landing page component
-
-Uses ComponentFn<AuthCatalog, "Home"> for catalog-typed props.
-NavBar handles the navigation — this component only renders content.

package/examples/@xmachines/play-react-demo/variables/Login.md

@@ -1,16 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Login
-
-# Variable: Login
-
-```ts
-const Login: ComponentFn<AuthCatalog, "Login">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Login.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Login.tsx#L14)
-
-Login — Authentication form
-
-Uses ComponentFn<AuthCatalog, "Login"> for catalog-typed props.
-Username is bound via $bindState from the spec — useStateBinding provides reactive two-way
-binding to the @xstate/store atom backing the current view's state store.
-Emits "submit" on form submit — spec resolves the username state and calls login handler.

package/examples/@xmachines/play-react-demo/variables/NavBar.md

@@ -1,16 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / NavBar
-
-# Variable: NavBar
-
-```ts
-const NavBar: FC<{
-	actor: AuthActor;
-}>;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/NavBar.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/NavBar.tsx#L12)
-
-NavBar — App-shell navigation component.
-
-Framework component (takes `actor`) used in the App shell header.
-Calls actor.send() directly for navigation — ActionProvider not needed here.

package/examples/@xmachines/play-react-demo/variables/NavBarView.md

@@ -1,15 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / NavBarView
-
-# Variable: NavBarView
-
-```ts
-const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/NavBarView.tsx#L11)
-
-NavBarView — Catalog-typed NavBar for use in defineRegistry components map.
-
-Receives props from the spec (isAuthenticated, username) and renders a
-static status indicator. Navigation buttons live in the shell-level NavBar
-component which calls actor.send() directly.

package/examples/@xmachines/play-react-demo/variables/Navigation.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Navigation
-
-# Variable: Navigation
-
-```ts
-const Navigation: ComponentFn<AuthCatalog, "Navigation">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Navigation.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Navigation.tsx#L10)
-
-Navigation - Status display component
-
-Uses ComponentFn<AuthCatalog, "Navigation"> for catalog-typed props.
-This component displays navigation state info. NavBar handles the actual navigation.

package/examples/@xmachines/play-react-demo/variables/Overview.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Overview
-
-# Variable: Overview
-
-```ts
-const Overview: ComponentFn<AuthCatalog, "Overview">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Overview.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Overview.tsx#L10)
-
-Overview - Dashboard overview child route component
-
-Uses ComponentFn<AuthCatalog, "Overview"> for catalog-typed props.
-Relative route "overview" resolves to /dashboard/overview.

package/examples/@xmachines/play-react-demo/variables/Panel.md

@@ -1,15 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Panel
-
-# Variable: Panel
-
-```ts
-const Panel: ComponentFn<AuthCatalog, "Panel">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Panel.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Panel.tsx#L11)
-
-Panel — generic container leaf for the 0.20 showcase.
-
-Renders an optional title and note, then its spec `children` — which is how
-repeat containers work: the element renders ONCE and its children render per
-item, so a Panel is both the list shell and the row.

package/examples/@xmachines/play-react-demo/variables/Profile.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Profile
-
-# Variable: Profile
-
-```ts
-const Profile: ComponentFn<AuthCatalog, "Profile">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
-
-Profile — Protected user profile page
-
-Uses ComponentFn<AuthCatalog, "Profile"> for catalog-typed props.
-NavBar handles the navigation — this component only renders content.

package/examples/@xmachines/play-react-demo/variables/Settings.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Settings
-
-# Variable: Settings
-
-```ts
-const Settings: ComponentFn<AuthCatalog, "Settings">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
-
-Settings — Protected settings page
-
-Uses ComponentFn<AuthCatalog, "Settings"> for catalog-typed props.
-NavBar handles the navigation — this component only renders content.

package/examples/@xmachines/play-react-demo/variables/Shell.md

@@ -1,19 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Shell
-
-# Variable: Shell
-
-```ts
-const Shell: FC<{
-	actor: AuthActor;
-	inspector: DemoInspector;
-	registryResult: DefineRegistryResult;
-	router?: unknown;
-}>;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
-
-Demo Shell layout component.
-
-Wraps NavBar, PlayRenderer, and DebugPanel in the standard demo chrome.
-Router-agnostic — all navigation is driven via play.route events on the actor.

package/examples/@xmachines/play-react-demo/variables/Stats.md

@@ -1,14 +0,0 @@
-[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Stats
-
-# Variable: Stats
-
-```ts
-const Stats: ComponentFn<AuthCatalog, "Stats">;
-```
-
-Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
-
-Stats - Dashboard stats child route component
-
-Uses ComponentFn<AuthCatalog, "Stats"> for catalog-typed props.
-Relative route "stats" resolves to /dashboard/stats.