diff --git a/docs/api/use-app-shell-config.md b/docs/api/use-app-shell-config.md index 335b7ed7..194e1477 100644 --- a/docs/api/use-app-shell-config.md +++ b/docs/api/use-app-shell-config.md @@ -15,13 +15,14 @@ const useAppShellConfig: () => AppShellConfig; ## Return Value -| Property | Type | Description | -| ------------------- | ------------------------------ | ------------------------------------------- | -| `title` | `string \| undefined` | App title | -| `icon` | `React.ReactNode \| undefined` | App icon | -| `basePath` | `string \| undefined` | Base path for all routes | -| `modules` | `Module[]` | Registered modules | -| `settingsResources` | `Resource[]` | Resources that appear only in Settings menu | +| Property | Type | Description | +| ------------------- | ------------------------------ | ------------------------------------------------ | +| `title` | `string \| undefined` | App title | +| `icon` | `React.ReactNode \| undefined` | App icon | +| `basePath` | `string \| undefined` | Base path for all routes | +| `modules` | `Module[]` | Registered modules | +| `settingsResources` | `Resource[]` | Resources that appear only in Settings menu | +| `appInfo` | `AppInfo \| undefined` | Configuration for the built-in `/__appinfo` page | ## Usage diff --git a/docs/components/app-shell.md b/docs/components/app-shell.md index bff523b3..24f91763 100644 --- a/docs/components/app-shell.md +++ b/docs/components/app-shell.md @@ -346,6 +346,39 @@ See [`SearchSource`](./command-palette.md#searchsource) for the full type refere > **Note:** `DefaultSidebar` always renders a **Search** entry that opens the palette regardless of whether `searchSources` is configured. The `Cmd+K` / `Ctrl+K` shortcut also works globally. +### appInfo + +- **Type:** `AppInfo` (optional) +- **Description:** Configuration for the built-in `/__appinfo` page, which exposes app metadata and the current AppShell version. The page is excluded from sidebar navigation but appears in the Command Palette as a page entry and includes a copy button for the rendered information. + +`AppInfo` has the following shape: + +| Property | Type | Description | +| ---------- | ------------------------- | ---------------------------------------------- | +| `metadata` | `readonly AppInfoEntry[]` | Additional rows shown on the `/__appinfo` page | + +Each `AppInfoEntry` has: + +| Property | Type | Description | +| -------- | -------------------------------------------------- | ------------------------------- | +| `label` | `string` | Display label shown on the page | +| `value` | `string \| number \| boolean \| null \| undefined` | Value rendered as text | + +```tsx + + {/* ... */} + +``` + ### children - **Type:** `React.ReactNode` (required)