Skip to content

Commit 192aba1

Browse files
committed
docs(spec): regenerate content/docs/references/ui/view.mdx after merging origin/main
os-regen-merge.sh step 3: the merge driver deferred this generated path (both sides changed it) and kept main's side; pnpm --filter @objectstack/spec gen:schema && gen:docs re-derives it on the merged tree, carrying forward both this branch's timeZone describe fix and main's #20474 round-trip-key docs. Claude-Session: https://claude.ai/code/session_014EJ1ED8X4MMrT18BhVx4tx Co-authored-by: Claude <noreply@anthropic.com>
1 parent ad11217 commit 192aba1

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎content/docs/references/ui/view.mdx‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2256,9 +2256,10 @@ This schema accepts one of the following structures:
22562256
| **_packageId** | `string` | optional | Owning package machine id. |
22572257
| **_packageVersion** | `string` | optional | Owning package version. |
22582258
| **_lockDocsUrl** | `string` | optional | Optional documentation link surfaced next to _lockReason. |
2259-
| **isPinned** | `boolean` | optional | Studio round-trip: view pinned in the switcher (per-user state, written by the console — not authored). |
2260-
| **sortOrder** | `integer` | optional | Studio round-trip: position within the switcher (per-user state, written by the console — not authored). |
2261-
| **columnState** | `{ order?: string[]; widths?: Record<string, number> }` | optional | Studio round-trip: per-user column order/widths (runtime-only state, written by the console grid — not authored) |
2259+
| **isPinned** | `boolean` | optional | Console round-trip: the view is pinned in the object's view switcher. Written by the console's pin toggle through the `view` metadata API and read back to draw the pinned group. Stored on the view's row, which has no per-user scope. Not authored. |
2260+
| **sortOrder** | `integer` | optional | Console round-trip: the view's position among the object's saved views in the switcher, 0-based and counted over saved views only (a code-defined view carries none). Written by the console's drag-reorder and read back to order the tabs. Not authored: `order` is the authored default position. |
2261+
| **visibility** | `Enum<'private' \| 'team' \| 'organization' \| 'public'>` | optional | Console round-trip: the group the switcher files this view's tab under (private, team, organization or public). Display grouping only, NOT access control: nothing restricts who can list or open the view by this value. No console control sets it; the console carries a stored value forward when it re-saves the row. Not authored. |
2262+
| **columnState** | `{ order?: string[]; widths?: Record<string, number> }` | optional | Studio round-trip: column order/widths (runtime-only state, written by the console grid and stored on the view's row, which has no per-user scope — not authored) |
22622263

22632264
### Nested Shape: `ViewItemWire[viewKind='list'].config`
22642265

@@ -2327,8 +2328,8 @@ This schema accepts one of the following structures:
23272328

23282329
| Property | Type | Required | Description |
23292330
| :--- | :--- | :--- | :--- |
2330-
| **order** | `string[]` | optional | Column order as field names, leftmost first (runtime-only per-user state — written by the console grid, never authored). |
2331-
| **widths** | `Record<string, number>` | optional | Column widths in pixels, keyed by field name (runtime-only per-user state — written by the console grid, never authored). |
2331+
| **order** | `string[]` | optional | Column order as field names, leftmost first (runtime-only state — written by the console grid, never authored). |
2332+
| **widths** | `Record<string, number>` | optional | Column widths in pixels, keyed by field name (runtime-only state — written by the console grid, never authored). |
23322333

23332334
---
23342335

@@ -2356,9 +2357,10 @@ This schema accepts one of the following structures:
23562357
| **_packageId** | `string` | optional | Owning package machine id. |
23572358
| **_packageVersion** | `string` | optional | Owning package version. |
23582359
| **_lockDocsUrl** | `string` | optional | Optional documentation link surfaced next to _lockReason. |
2359-
| **isPinned** | `boolean` | optional | Studio round-trip: view pinned in the switcher (per-user state, written by the console — not authored). |
2360-
| **sortOrder** | `integer` | optional | Studio round-trip: position within the switcher (per-user state, written by the console — not authored). |
2361-
| **columnState** | `{ order?: string[]; widths?: Record<string, number> }` | optional | Studio round-trip: per-user column order/widths (runtime-only state, written by the console grid — not authored) |
2360+
| **isPinned** | `boolean` | optional | Console round-trip: the view is pinned in the object's view switcher. Written by the console's pin toggle through the `view` metadata API and read back to draw the pinned group. Stored on the view's row, which has no per-user scope. Not authored. |
2361+
| **sortOrder** | `integer` | optional | Console round-trip: the view's position among the object's saved views in the switcher, 0-based and counted over saved views only (a code-defined view carries none). Written by the console's drag-reorder and read back to order the tabs. Not authored: `order` is the authored default position. |
2362+
| **visibility** | `Enum<'private' \| 'team' \| 'organization' \| 'public'>` | optional | Console round-trip: the group the switcher files this view's tab under (private, team, organization or public). Display grouping only, NOT access control: nothing restricts who can list or open the view by this value. No console control sets it; the console carries a stored value forward when it re-saves the row. Not authored. |
2363+
| **columnState** | `{ order?: string[]; widths?: Record<string, number> }` | optional | Studio round-trip: column order/widths (runtime-only state, written by the console grid and stored on the view's row, which has no per-user scope — not authored) |
23622364

23632365
### Nested Shape: `ViewItemWire[viewKind='form'].config`
23642366

@@ -2402,8 +2404,8 @@ This schema accepts one of the following structures:
24022404

24032405
| Property | Type | Required | Description |
24042406
| :--- | :--- | :--- | :--- |
2405-
| **order** | `string[]` | optional | Column order as field names, leftmost first (runtime-only per-user state — written by the console grid, never authored). |
2406-
| **widths** | `Record<string, number>` | optional | Column widths in pixels, keyed by field name (runtime-only per-user state — written by the console grid, never authored). |
2407+
| **order** | `string[]` | optional | Column order as field names, leftmost first (runtime-only state — written by the console grid, never authored). |
2408+
| **widths** | `Record<string, number>` | optional | Column widths in pixels, keyed by field name (runtime-only state — written by the console grid, never authored). |
24072409

24082410
---
24092411

0 commit comments

Comments
 (0)