@zeyos/zx 5.0.0 → 5.2.0

package/docs/api.json

@@ -80,6 +80,12 @@
         "returns": "this",
         "description": "Replaces account presentation without touching session state."
       },
+      {
+        "name": "setCompact",
+        "signature": "setCompact(compact)",
+        "returns": "this",
+        "description": "Shows the avatar alone or the avatar with the name and secondary line — for a navigation column that narrows to icons and widens again. The trigger keeps its full accessible name either way."
+      },
       {
         "name": "setItems",
         "signature": "setItems(items)",
@@ -390,7 +396,13 @@
         "name": "color",
         "type": "string|null",
         "default": "null",
-        "description": "Identity colour; falls back to the accent colour."
+        "description": "Identity colour, any CSS colour; takes precedence over `tone`."
+      },
+      {
+        "name": "tone",
+        "type": "AppIconTone|null",
+        "default": "null",
+        "description": "Categorical identity colour from the theme's tone palette, drawn with its `--zx-color-tone-<tone>-solid` fill. Without `color` or `tone` the icon takes the accent."
       },
       {
         "name": "size",
@@ -461,9 +473,9 @@
     "options": [
       {
         "name": "items",
-        "type": "AppNavItem[]",
+        "type": "AppNavItem[]|AppSidebarModule[]",
         "default": "[]",
-        "description": "Application navigation tree."
+        "description": "Application navigation tree; in the modules layout its top level is the modules."
       },
       {
         "name": "active",
@@ -501,6 +513,42 @@
         "default": "'left'",
         "description": "Workspace edge occupied by navigation."
       },
+      {
+        "name": "layout",
+        "type": "'tree'|'modules'",
+        "default": "'tree'",
+        "description": "`'modules'` draws the top level as a module strip beside a panel showing one module's menu; minimized, the strip remains and menus open as flyouts."
+      },
+      {
+        "name": "module",
+        "type": "string|number|null",
+        "default": "null",
+        "description": "Modules layout: the module the panel shows first. Defaults to the module containing `active`, else the first module with a panel."
+      },
+      {
+        "name": "moduleBar",
+        "type": "AppSidebarModuleBarOptions",
+        "default": "{}",
+        "description": "Modules layout: strip presentation."
+      },
+      {
+        "name": "presentation",
+        "type": "'expanded'|'compact'|'collapsed'|null",
+        "default": "null",
+        "description": "Modules layout: how much of the navigation shows — both menus expanded (module names beside the side menu), the module menu collapsed to icons beside the side menu, or both collapsed to the icon strip. Defaults to `collapsed` ? `'collapsed'` : `'expanded'`."
+      },
+      {
+        "name": "presentations",
+        "type": "Array<'expanded'|'compact'|'collapsed'>",
+        "default": "['expanded','compact','collapsed']",
+        "description": "Modules layout: the presentations offered, widest first."
+      },
+      {
+        "name": "presentationSwitch",
+        "type": "boolean",
+        "default": "true",
+        "description": "Modules layout: whether the strip's foot carries the switch between presentations. Turn it off when the choice lives elsewhere — an account menu, through `presentationChoice()`."
+      },
       {
         "name": "label",
         "type": "string",
@@ -511,7 +559,7 @@
         "name": "header",
         "type": "Node|string|number|{toElement: () => Node|null}|null",
         "default": "null",
-        "description": "Expanded header content."
+        "description": "Expanded header content; in the modules layout, content above every module's menu."
       },
       {
         "name": "footer",
@@ -523,13 +571,13 @@
         "name": "railHeader",
         "type": "Node|string|number|{toElement: () => Node|null}|null",
         "default": "null",
-        "description": "Minimized leading content."
+        "description": "Minimized leading content; in the modules layout, the strip's leading content in both states."
       },
       {
         "name": "railFooter",
         "type": "Node|string|number|{toElement: () => Node|null}|null",
         "default": "null",
-        "description": "Minimized trailing content."
+        "description": "Minimized trailing content; in the modules layout, the strip's trailing content in both states."
       },
       {
         "name": "openDelay",
@@ -570,6 +618,16 @@
         "name": "flyoutchange",
         "payload": "{item: AppNavItem, id: string|number, open: boolean}",
         "description": "Minimized flyout-state listener."
+      },
+      {
+        "name": "modulechange",
+        "payload": "{item: AppNavItem, id: string|number, previous: string|number|null}",
+        "description": "Preventable module-switch listener."
+      },
+      {
+        "name": "presentationchange",
+        "payload": "{presentation: 'expanded'|'compact'|'collapsed', previous: 'expanded'|'compact'|'collapsed'}",
+        "description": "Presentation listener."
       }
     ],
     "methods": [
@@ -589,7 +647,49 @@
         "name": "setActive",
         "signature": "setActive(id)",
         "returns": "this",
-        "description": "Sets the active id without routing."
+        "description": "Sets the active id without routing. In the modules layout the panel follows the active route into its module."
+      },
+      {
+        "name": "setBadge",
+        "signature": "setBadge(id, badge)",
+        "returns": "this",
+        "description": "Updates one badge — a module's, or any destination's — without rebuilding the navigation."
+      },
+      {
+        "name": "setModule",
+        "signature": "setModule(id, [options])",
+        "returns": "this",
+        "description": "Modules layout: shows a module's menu in the panel. Fires a preventable `modulechange` unless silent."
+      },
+      {
+        "name": "getModule",
+        "signature": "getModule()",
+        "returns": "string|number|null",
+        "description": "Modules layout: the module whose menu the panel shows."
+      },
+      {
+        "name": "setModuleLabels",
+        "signature": "setModuleLabels(labels)",
+        "returns": "this",
+        "description": "Modules layout: whether the strip prints module names — `'auto'` (beside the tiles while expanded, none while collapsed), `'beside'`, `'below'`, or `'hidden'`. A narrow drawer that has no room for a labelled strip beside the panel sets `'hidden'`."
+      },
+      {
+        "name": "getPresentation",
+        "signature": "getPresentation()",
+        "returns": "'expanded'|'compact'|'collapsed'",
+        "description": "How much of the navigation shows: `'expanded'` (in the modules layout, both menus), `'compact'` (the module menu collapsed to icons beside the side menu), or `'collapsed'`."
+      },
+      {
+        "name": "setPresentation",
+        "signature": "setPresentation(presentation, [options])",
+        "returns": "this",
+        "description": "Shows the navigation as `'expanded'`, `'compact'` (modules layout), or `'collapsed'`."
+      },
+      {
+        "name": "togglePresentation",
+        "signature": "togglePresentation()",
+        "returns": "this",
+        "description": "Moves to the next presentation the strip's switch offers, wrapping (Mod+B in an application)."
       },
       {
         "name": "setExpanded",
@@ -667,16 +767,52 @@
         "name": "focus",
         "signature": "focus()",
         "returns": "this",
-        "description": "Focuses the first navigation action."
+        "description": "Focuses the first navigation action: the module strip's Tab stop in the modules layout."
       },
       {
         "name": "destroy",
         "signature": "destroy()",
         "returns": "void",
         "description": "Destroys flyouts and restores/removes the host."
+      },
+      {
+        "name": "presentationChoice",
+        "signature": "presentationChoice([options])",
+        "returns": "import('../../internal/menu-items.js').MenuChoice",
+        "description": "The choice between presentations as a menu entry, for an account or settings menu that holds it instead of the strip: `account.setItems([sidebar.presentationChoice(), …])`. It reads the current presentation when called, so rebuild it after `presentationchange`."
       }
     ]
   },
+  "AppSidebarModuleBar": {
+    "options": [
+      {
+        "name": "appearance",
+        "type": "'tint'|'solid'|'plain'",
+        "default": "'tint'",
+        "description": "Tile treatment."
+      },
+      {
+        "name": "labels",
+        "type": "'auto'|'beside'|'below'|'hidden'",
+        "default": "'auto'",
+        "description": "Module names on the strip: `'auto'` prints them beside the tiles while expanded and leaves the icons alone while collapsed; `'hidden'` keeps the icon strip beside the panel; `'below'` prints them under the tiles."
+      },
+      {
+        "name": "allModules",
+        "type": "'auto'|'always'|'never'",
+        "default": "'auto'",
+        "description": "The \"All modules\" button."
+      },
+      {
+        "name": "label",
+        "type": "string|null",
+        "default": "null",
+        "description": "Strip accessible label; omitted resolves `moduleBar.label`."
+      }
+    ],
+    "events": [],
+    "methods": []
+  },
   "Aspect": {
     "options": [
       {
@@ -1298,7 +1434,7 @@
         "name": "msg",
         "type": "Record<string, string>",
         "default": null,
-        "description": "Localized component messages."
+        "description": "Per-instance messages, keyed `calendar.*` (`calendar.today`, `calendar.next`, …). The bare keys of earlier versions (`today`, `next`) are still read, after the namespaced key, until the next major version."
       },
       {
         "name": "renderEvent",
@@ -1775,9 +1911,9 @@
       },
       {
         "name": "label",
-        "type": "string",
-        "default": "'Card view'",
-        "description": "Accessible collection label."
+        "type": "string|null",
+        "default": "null",
+        "description": "Accessible collection label; null resolves message `cardView.label`, \"Card view\"."
       }
     ],
     "events": [
@@ -2551,7 +2687,7 @@
         "name": "clearLabel",
         "type": "string|null",
         "default": "null",
-        "description": "Clear button label; null resolves `dataFilter.clear`."
+        "description": "Clear button label; null resolves message `dataFilter.clear`, \"Clear\"."
       }
     ],
     "events": [
@@ -3805,6 +3941,12 @@
         "default": "false",
         "description": "Whether the control is disabled."
       },
+      {
+        "name": "readonly",
+        "type": "boolean",
+        "default": "false",
+        "description": "Whether the value is read-only: shown and focusable, not editable. Types whose control has no read-only state (`checkbox`, `select`, `optionlist`, `zxselect`, `date`, `time`, …) ignore it."
+      },
       {
         "name": "options",
         "type": "string[]|Record<string, string>|null",
@@ -3885,6 +4027,12 @@
         "returns": "this",
         "description": "Enables or disables the adapter control."
       },
+      {
+        "name": "setReadonly",
+        "signature": "setReadonly(readonly)",
+        "returns": "this",
+        "description": "Makes the value read-only or editable again, where the control has a read-only state (see the `readonly` option); reflected as `data-readonly` on the root either way."
+      },
       {
         "name": "setHighlight",
         "signature": "setHighlight(message, [kind])",
@@ -4061,7 +4209,7 @@
         "name": "addField",
         "signature": "addField(id, field)",
         "returns": "Field",
-        "description": "Adds a field from options, an existing field, an element, or a component. The key becomes the field's `name` and its `data-field-id`; the control's DOM id is `<idPrefix>-<key>`, unless the field options give an `id` of their own that differs from the key."
+        "description": "Adds a field from options, an existing field, an element, or a component. The key becomes the field's `name` and its `data-field-id`; the control's DOM id is `<idPrefix>-<key>`, unless the field options give an `id` of their own that differs from the key. An element or a component that is not a registered field type is wrapped in a `custom` field that reads and writes it through its own API — `getValue`/`setValue`, `get`/`set`, `getValues`/`setValues`, `isChecked`/`setChecked`, or a `value` property — disables it through `setDisabled(bool)` or `enable()`/`disable()`, and makes it read-only through `setReadonly(bool)`, falling back to the element's native properties only when the component has none of these. The component's own `change` becomes the field's `change`, once per edit."
       },
       {
         "name": "getField",
@@ -4448,13 +4596,13 @@
         "name": "searchable",
         "type": "boolean",
         "default": "false",
-        "description": "Searchable field, operator and single-choice controls."
+        "description": "Searchable field, operator and single-choice controls; a many-valued operator on a field with static choices gets a `TagPicker`."
       },
       {
         "name": "layout",
         "type": "'standard'|'compact'",
         "default": "'standard'",
-        "description": "Condition layout; compact rows adapt to container width."
+        "description": "Condition layout; compact rows adapt to container width and show the group's \"and\"/\"or\" between them, a click on it switching the group's logic."
       },
       {
         "name": "rootLogic",
@@ -4638,6 +4786,12 @@
         "default": "'seconds'",
         "description": "How a date leaves the component. A range's lower bound takes the start of its day and its upper bound the end, so a one-day range matches."
       },
+      {
+        "name": "timeZone",
+        "type": "string|null",
+        "default": "null",
+        "description": "IANA zone the calendar days are counted in, such as the ZeyOS instance's `Europe/Vienna`. A day serializes as the first (or last) instant of that day in this zone, and an incoming instant shows as the day it falls on there — the same rule `zeyosForm()` and `zeyosTable()` apply to date-only fields. Null uses the runtime's own zone. An unknown zone throws a `RangeError`."
+      },
       {
         "name": "emptyText",
         "type": "string|null",
@@ -6128,7 +6282,7 @@
         "name": "bind",
         "signature": "bind(view)",
         "returns": "this",
-        "description": "Optional sugar for a `TableView` or `CardView`: it wires the shape switch to the view and mounts the view's field chooser into this bar. Nothing is imported and nothing is required — every capability is feature-detected, so a view that offers none of them still works and still gets `viewchange`, and the host swaps the view itself. See `recordViewCapabilities()` for what is looked for."
+        "description": "Optional sugar for a `TableView`, `CardView`, or `KanbanView`: it wires the shape switch to the view and mounts the view's field chooser into this bar — through the view's public `mountFieldControls()` when it has one, which every `RecordView` does. A `TableView` with the default `fieldControls: true` contributes its Table's column chooser. Nothing is imported and nothing is required — every capability is feature-detected, so a view that offers none of them still works and still gets `viewchange`, and the host swaps the view itself. See `recordViewCapabilities()` for what is looked for."
       },
       {
         "name": "unbind",
@@ -6274,6 +6428,12 @@
         "returns": "this",
         "description": "Closes the menu."
       },
+      {
+        "name": "toggle",
+        "signature": "toggle()",
+        "returns": "this",
+        "description": "Opens the menu when it is closed, and closes it when it is open. Opening this way moves no focus; `focusFirst()` opens with focus on the first item."
+      },
       {
         "name": "isOpen",
         "signature": "isOpen()",
@@ -6522,6 +6682,226 @@
       }
     ]
   },
+  "ModuleBar": {
+    "options": [
+      {
+        "name": "items",
+        "type": "ModuleItem[]",
+        "default": "[]",
+        "description": "Modules, in bar order."
+      },
+      {
+        "name": "active",
+        "type": "string|number|null",
+        "default": "null",
+        "description": "Active destination id: a module, or any item in a module's menu."
+      },
+      {
+        "name": "orientation",
+        "type": "'vertical'|'horizontal'",
+        "default": "'vertical'",
+        "description": "Bar flow."
+      },
+      {
+        "name": "side",
+        "type": "'left'|'right'|'top'|'bottom'",
+        "default": "'left'",
+        "description": "Workspace edge the bar occupies."
+      },
+      {
+        "name": "appearance",
+        "type": "'tint'|'solid'|'plain'",
+        "default": "'tint'",
+        "description": "Tile treatment: the glyph in the module colour on a tint of it, the solid identity tile, or monochrome glyphs."
+      },
+      {
+        "name": "labels",
+        "type": "'hidden'|'below'|'beside'",
+        "default": "'hidden'",
+        "description": "Whether a vertical bar prints each module's name: under its tile (a narrow strip), beside it (a full navigation column, with the count at the end of the row), or not at all — the name then stays the accessible name and the tooltip. Horizontal bars never print names."
+      },
+      {
+        "name": "menus",
+        "type": "'flyout'|'none'",
+        "default": "'flyout'",
+        "description": "How a module's children are presented: in a flyout, or by an adjacent panel the application owns, in which case activating the module emits `select`."
+      },
+      {
+        "name": "expanded",
+        "type": "string|number|null",
+        "default": "null",
+        "description": "With `menus: 'none'`, the module whose menu the adjacent panel shows."
+      },
+      {
+        "name": "controls",
+        "type": "string|null",
+        "default": "null",
+        "description": "With `menus: 'none'`, the id of that panel."
+      },
+      {
+        "name": "allModules",
+        "type": "'auto'|'always'|'never'",
+        "default": "'auto'",
+        "description": "The \"All modules\" button: shown when a module does not fit or is unpinned, always, or never (the bar then scrolls)."
+      },
+      {
+        "name": "header",
+        "type": "Node|string|number|{toElement: () => Node|null}|null",
+        "default": "null",
+        "description": "Leading content, such as a product mark."
+      },
+      {
+        "name": "footer",
+        "type": "Node|string|number|{toElement: () => Node|null}|null",
+        "default": "null",
+        "description": "Trailing content, such as an account menu."
+      },
+      {
+        "name": "label",
+        "type": "string|null",
+        "default": "null",
+        "description": "Navigation accessible label. Omitted resolves `moduleBar.label`, English `Modules`."
+      },
+      {
+        "name": "openDelay",
+        "type": "number",
+        "default": "80",
+        "description": "Flyout hover-open delay in milliseconds."
+      },
+      {
+        "name": "closeDelay",
+        "type": "number",
+        "default": "160",
+        "description": "Flyout pointer and focus crossing grace in milliseconds."
+      },
+      {
+        "name": "renderIcon",
+        "type": "(item: AppNavItem, context: Record<string, any>) => Node|null",
+        "default": null,
+        "description": "Optional host icon renderer."
+      }
+    ],
+    "events": [
+      {
+        "name": "select",
+        "payload": "AppNavSelectDetail",
+        "description": "Preventable activation listener."
+      },
+      {
+        "name": "flyoutchange",
+        "payload": "{item: AppNavItem, id: string|number, open: boolean}",
+        "description": "Flyout-state listener."
+      },
+      {
+        "name": "overflowchange",
+        "payload": "{visible: Array<string|number>, overflow: Array<string|number>}",
+        "description": "Overflow listener."
+      },
+      {
+        "name": "allmodules",
+        "payload": "{open: boolean}",
+        "description": "\"All modules\" catalogue open-state listener."
+      }
+    ],
+    "methods": [
+      {
+        "name": "setItems",
+        "signature": "setItems(items)",
+        "returns": "this",
+        "description": "Replaces the modules and rebuilds the bar."
+      },
+      {
+        "name": "getItems",
+        "signature": "getItems()",
+        "returns": "ModuleItem[]",
+        "description": "Returns a copy of the normalized modules."
+      },
+      {
+        "name": "setActive",
+        "signature": "setActive(id)",
+        "returns": "this",
+        "description": "Marks the active destination — a module, or anything in a module's menu — without routing. The module holding it becomes current and stays on the bar."
+      },
+      {
+        "name": "openFlyout",
+        "signature": "openFlyout(id, [options])",
+        "returns": "this",
+        "description": "Opens a module's menu flyout."
+      },
+      {
+        "name": "closeFlyout",
+        "signature": "closeFlyout(id)",
+        "returns": "this",
+        "description": "Closes a module's menu flyout."
+      },
+      {
+        "name": "closeAllFlyouts",
+        "signature": "closeAllFlyouts()",
+        "returns": "this",
+        "description": "Closes every menu flyout."
+      },
+      {
+        "name": "isFlyoutOpen",
+        "signature": "isFlyoutOpen(id)",
+        "returns": "boolean",
+        "description": "Reports whether a module's menu flyout is open."
+      },
+      {
+        "name": "setExpanded",
+        "signature": "setExpanded(id)",
+        "returns": "this",
+        "description": "With `menus: 'none'`, names the module whose menu the adjacent panel now shows."
+      },
+      {
+        "name": "setBadge",
+        "signature": "setBadge(id, badge)",
+        "returns": "this",
+        "description": "Updates one badge in place — on the tile, in a flyout, and in the catalogue — without rebuilding the bar. `null` removes it."
+      },
+      {
+        "name": "setLayout",
+        "signature": "setLayout(layout)",
+        "returns": "this",
+        "description": "Changes flow or edge, keeping items, the active destination, and the expanded module."
+      },
+      {
+        "name": "setLabels",
+        "signature": "setLabels(labels)",
+        "returns": "this",
+        "description": "Changes whether module names are printed — the expanded and collapsed states of a vertical navigation column — keeping items, the active destination, and the expanded module."
+      },
+      {
+        "name": "openAllModules",
+        "signature": "openAllModules()",
+        "returns": "this",
+        "description": "Opens the \"All modules\" catalogue and focuses its filter or first entry."
+      },
+      {
+        "name": "closeAllModules",
+        "signature": "closeAllModules()",
+        "returns": "this",
+        "description": "Closes the \"All modules\" catalogue."
+      },
+      {
+        "name": "isAllModulesOpen",
+        "signature": "isAllModulesOpen()",
+        "returns": "boolean",
+        "description": "Reports whether the \"All modules\" catalogue is open."
+      },
+      {
+        "name": "focus",
+        "signature": "focus()",
+        "returns": "this",
+        "description": "Focuses the bar's Tab stop: the current module, else the first tile."
+      },
+      {
+        "name": "destroy",
+        "signature": "destroy()",
+        "returns": "void",
+        "description": "Destroys flyouts, tooltips, and the catalogue, and restores or removes the root."
+      }
+    ]
+  },
   "MonthPicker": {
     "options": [
       {
@@ -7789,6 +8169,12 @@
         "type": "Node[]",
         "default": "[]",
         "description": "Listener-free, owner-created controls such as a move handle."
+      },
+      {
+        "name": "message",
+        "type": "(key: string, ...args: unknown[]) => string",
+        "default": null,
+        "description": "Resolves the card's built-in strings (`recordCard.select`, `recordCard.actions`, `recordCard.untitled`, `recordCard.selected`, `recordCard.notSelected`). An owning component passes its own `msg()`; omitted, the host translator and then the default English catalogue answer."
       }
     ],
     "events": [],
@@ -7978,6 +8364,18 @@
         "returns": "string[]",
         "description": "Returns the complete field id order."
       },
+      {
+        "name": "getFieldControls",
+        "signature": "getFieldControls()",
+        "returns": "HTMLElement|null",
+        "description": "Returns the element that lets a reader show, hide, and reorder this view's fields: the shared field chooser, or — for a `TableView` with `fieldControls: true` — the column chooser of its composed `Table`. Null when the view renders none (`fieldControls: false`). The element stays owned by the view: move it with {@link RecordView#mountFieldControls} rather than appending it elsewhere yourself, so `destroy()` can still find and remove it."
+      },
+      {
+        "name": "mountFieldControls",
+        "signature": "mountFieldControls(target)",
+        "returns": "HTMLElement|null",
+        "description": "Moves the view's field chooser into a host element — a list toolbar, a pane header — or, with `null`, back to where the view first rendered it. It keeps driving this view wherever it sits, and `destroy()` removes it from the host. `ListToolbar.bind()` calls this for every record view, which is how its field chooser ends up in the bar."
+      },
       {
         "name": "setFieldVisible",
         "signature": "setFieldVisible(id, [visible], [options])",
@@ -8309,6 +8707,12 @@
       }
     ],
     "methods": [
+      {
+        "name": "get",
+        "signature": "get()",
+        "returns": "unknown",
+        "description": "Returns the selected item ID, or null: the same as reading `value`, under the `get()`/`set()` pair the other value components share."
+      },
       {
         "name": "set",
         "signature": "set(idOrItem, [options])",
@@ -9822,6 +10226,24 @@
         "type": "false|TableHierarchyOptions",
         "default": "false",
         "description": "Flat parent references projected as an expandable treegrid. Row data and mutation APIs remain flat."
+      },
+      {
+        "name": "interactive",
+        "type": "boolean",
+        "default": "false",
+        "description": "Makes the table an APG grid — row focus, Enter firing `rowclick` — even without selection, editing, or hierarchy, which already imply it. Attaching a `rowclick` or `rowdblclick` listener through `on()` or an `on…` option sets it too; pass it when the host listens for the bubbling `zx-rowclick` DOM event instead."
+      },
+      {
+        "name": "label",
+        "type": "string|null",
+        "default": "null",
+        "description": "Accessible name of the table. A grid must have one; null resolves the `table.label` message (English \"Table\") for a grid and leaves a plain table unnamed, so name it after what it lists."
+      },
+      {
+        "name": "labelledBy",
+        "type": "string|null",
+        "default": "null",
+        "description": "Id of an element that names the grid — the heading above it, say. Wins over `label`."
       }
     ],
     "events": [
@@ -10130,6 +10552,12 @@
         "returns": "number",
         "description": "How many rows are currently rendered."
       },
+      {
+        "name": "addEventListener",
+        "signature": "addEventListener(type, listener, [options])",
+        "returns": "void",
+        "description": "Registers a listener, and turns the table into a grid when the listener is for a row click: a host that reacts to the row needs the row reachable by keyboard."
+      },
       {
         "name": "isStacked",
         "signature": "isStacked()",
@@ -11420,5 +11848,354 @@
         "description": "Disables editing, removal, and reordering."
       }
     ]
+  },
+  "ViewSettings": {
+    "options": [
+      {
+        "name": "fields",
+        "type": "ViewSettingsField[]",
+        "default": "[]",
+        "description": "Field descriptors, in their default order. Bound to a view, a non-empty list is also the allow-list: the view's other fields are neither listed nor touched. An empty list takes every field the view has."
+      },
+      {
+        "name": "fieldOrder",
+        "type": "string[]",
+        "default": "[]",
+        "description": "Preferred field order; missing fields append."
+      },
+      {
+        "name": "hiddenFields",
+        "type": "string[]",
+        "default": "[]",
+        "description": "Hidden field ids. A field with `visible: false` starts hidden too; a locked field never does."
+      },
+      {
+        "name": "groupBy",
+        "type": "string|null",
+        "default": "null",
+        "description": "Initial grouping field."
+      },
+      {
+        "name": "grouping",
+        "type": "boolean|ViewSettingsGrouping",
+        "default": "true",
+        "description": "The Group section. `false` omits it; an object restricts the fields it offers."
+      },
+      {
+        "name": "board",
+        "type": "ViewSettingsBoardOptions|false",
+        "default": "false",
+        "description": "The Board section (column field, swim-lane field, show empty columns) with its initial values and, in `fields`, the fields it offers; `false` omits it."
+      },
+      {
+        "name": "sections",
+        "type": "ViewSettingsSection[]",
+        "default": null,
+        "description": "Order and presence of the sections. Defaults to `['fields', 'grouping', 'board']`; a section whose option is `false` is always left out."
+      },
+      {
+        "name": "types",
+        "type": "Record<string, {icon?: string, label?: string}>",
+        "default": "{}",
+        "description": "Extends or overrides the built-in type map, keyed by type name."
+      },
+      {
+        "name": "searchThreshold",
+        "type": "number",
+        "default": "8",
+        "description": "Field count above which the field search is shown."
+      },
+      {
+        "name": "headingLevel",
+        "type": "2|3|4|5|6",
+        "default": "3",
+        "description": "Heading level of the section headings."
+      },
+      {
+        "name": "label",
+        "type": "string|null",
+        "default": "null",
+        "description": "Accessible name of the region; omitted uses the `viewSettings.label` message (\"View settings\")."
+      },
+      {
+        "name": "msg",
+        "type": "Record<string, string>|Record<string, Record<string, string>>",
+        "default": null,
+        "description": "Localized messages."
+      }
+    ],
+    "events": [
+      {
+        "name": "change",
+        "payload": "{state: ViewSettingsState, reason: ViewSettingsChangeReason}",
+        "description": "Any change the reader made."
+      },
+      {
+        "name": "fieldorderchange",
+        "payload": "{order: string[]}",
+        "description": "Field order changed."
+      },
+      {
+        "name": "fieldvisibilitychange",
+        "payload": "{visible: string[], hidden: string[]}",
+        "description": "A field was added or hidden."
+      },
+      {
+        "name": "groupchange",
+        "payload": "{field: string|null}",
+        "description": "Grouping field changed."
+      },
+      {
+        "name": "boardchange",
+        "payload": "{board: ViewSettingsBoard}",
+        "description": "Board settings changed."
+      }
+    ],
+    "methods": [
+      {
+        "name": "getState",
+        "signature": "getState()",
+        "returns": "ViewSettingsState",
+        "description": "Returns the current settings as a JSON-safe snapshot."
+      },
+      {
+        "name": "setState",
+        "signature": "setState(partial, [options])",
+        "returns": "this",
+        "description": "Applies part of a state. Unknown field ids are ignored, missing ones append, and a locked field stays shown. Each part that actually changes emits its own event unless `silent`. A keyboard pick-up or pointer drag in progress is canceled first."
+      },
+      {
+        "name": "setFields",
+        "signature": "setFields(fields)",
+        "returns": "this",
+        "description": "Replaces the field descriptors, keeping order, visibility, grouping, and board settings for every id that still exists. While a view is bound, the view owns the field list: change it with the view's own `setFields()` and the panel follows through `statechange`. A `setFields()` here is not pushed to the view and lasts only until the view's next change."
+      },
+      {
+        "name": "getFields",
+        "signature": "getFields()",
+        "returns": "ViewSettingsField[]",
+        "description": "Returns the field descriptors in their current order."
+      },
+      {
+        "name": "showField",
+        "signature": "showField(id)",
+        "returns": "this",
+        "description": "Shows a hidden field at the end of the shown list."
+      },
+      {
+        "name": "hideField",
+        "signature": "hideField(id)",
+        "returns": "this",
+        "description": "Hides a shown field. A locked field and the last shown field cannot be hidden."
+      },
+      {
+        "name": "moveField",
+        "signature": "moveField(id, index)",
+        "returns": "this",
+        "description": "Moves a shown field to a position among the movable shown fields (locked ones keep theirs)."
+      },
+      {
+        "name": "bind",
+        "signature": "bind(view, [options])",
+        "returns": "this",
+        "description": "Connects a record view (`TableView`, `CardView`, `KanbanView`, or anything exposing the `RecordView` state surface). The view's fields and state are read now; order and visibility changes made here are pushed through `setFieldOrder()` and `setFieldVisible()`; and the view's own `statechange` is followed, so a column hidden from a table header disappears here too. The view's labels and types win over the panel's own descriptors, which supply only what the view lacks (`locked`, `groupable`, a type the view leaves at its `'text'` default). While bound, the view owns the field list; see `setFields()`. Grouping and board settings are never applied to the view — they are emitted, and the host decides (a `CardView` is re-created or given a new `groupBy`, a `KanbanView` its axes). A view's own `groupBy`, `columnBy`, and `swimlaneBy` options are adopted when they name fields."
+      },
+      {
+        "name": "unbind",
+        "signature": "unbind()",
+        "returns": "this",
+        "description": "Releases a bound view. The settings keep their current state."
+      },
+      {
+        "name": "focus",
+        "signature": "focus()",
+        "returns": "this",
+        "description": "Focuses the field search, or the first control of the shown list when there is no search."
+      },
+      {
+        "name": "destroy",
+        "signature": "destroy()",
+        "returns": "void",
+        "description": "Destroys the nested controls, releases a bound view, and restores an enhanced target."
+      }
+    ]
+  },
+  "ViewSettingsBoard": {
+    "options": [
+      {
+        "name": "columnBy",
+        "type": "string|null",
+        "default": "null",
+        "description": "Initial column field."
+      },
+      {
+        "name": "swimlaneBy",
+        "type": "string|null",
+        "default": "null",
+        "description": "Initial swim-lane field, or null for none."
+      },
+      {
+        "name": "showEmptyColumns",
+        "type": "boolean",
+        "default": "true",
+        "description": "Whether columns without cards stay visible."
+      },
+      {
+        "name": "fields",
+        "type": "string[]",
+        "default": null,
+        "description": "The field ids offered for columns and swim lanes, in this order. Omitted offers the same fields as the Group section."
+      }
+    ],
+    "events": [],
+    "methods": []
+  },
+  "WorkspaceSwitcher": {
+    "options": [
+      {
+        "name": "workspaces",
+        "type": "WorkspaceItem[]",
+        "default": "[]",
+        "description": "Workspaces in menu order. Entries without an id are skipped, and a repeated id keeps its first entry."
+      },
+      {
+        "name": "active",
+        "type": "string|number|null",
+        "default": "null",
+        "description": "Active workspace id. Defaults to the first enabled workspace, which also stands in for an id that is not listed or is disabled."
+      },
+      {
+        "name": "items",
+        "type": "MenuButtonItem[]",
+        "default": "[]",
+        "description": "Extra actions listed after the workspaces — \"Create workspace\", \"Workspace settings\", `'-'` separators, \"Sign out\". A separator is inserted between the workspaces and the actions automatically."
+      },
+      {
+        "name": "compact",
+        "type": "boolean",
+        "default": "false",
+        "description": "Whether the trigger shows the tile alone."
+      },
+      {
+        "name": "heading",
+        "type": "string|null",
+        "default": "null",
+        "description": "Group label above the workspaces; null resolves message `workspaceSwitcher.heading` (\"Workspaces\"), and an empty string leaves the label out."
+      },
+      {
+        "name": "label",
+        "type": "string|null",
+        "default": "null",
+        "description": "Trigger accessible name, in which `%1` is the active workspace's name and is filled in again after every switch. Null resolves message `workspaceSwitcher.label` (\"Switch workspace: %1\"), or `workspaceSwitcher.labelEmpty` (\"Switch workspace\") while no workspace is active."
+      },
+      {
+        "name": "placement",
+        "type": "'bottom-start'|'bottom-end'|'top-start'|'top-end'|'bottom'|'top'|'right-start'|'right-end'|'left-start'|'left-end'|'right'|'left'",
+        "default": "'bottom-start'",
+        "description": "Popup placement."
+      },
+      {
+        "name": "msg",
+        "type": "Record<string, unknown>",
+        "default": null,
+        "description": "Component-local message overrides, by key: `workspaceSwitcher.heading` (\"Workspaces\"), `workspaceSwitcher.label` (\"Switch workspace: %1\", `%1` the active workspace's name), and `workspaceSwitcher.labelEmpty` (\"Switch workspace\", the trigger's name while no workspace is active)."
+      }
+    ],
+    "events": [
+      {
+        "name": "select",
+        "payload": "{workspace, id, previous}",
+        "description": "Preventable workspace switch; `preventDefault()` keeps the previous workspace active and the menu open."
+      },
+      {
+        "name": "action",
+        "payload": "{value: unknown, item: object}",
+        "description": "Preventable extra action; `preventDefault()` skips the item's own callback and keeps the menu open."
+      },
+      {
+        "name": "open",
+        "payload": "Record<string, never>",
+        "description": "Open listener."
+      },
+      {
+        "name": "close",
+        "payload": "Record<string, never>",
+        "description": "Close listener."
+      }
+    ],
+    "methods": [
+      {
+        "name": "getActive",
+        "signature": "getActive()",
+        "returns": "WorkspaceItem|null",
+        "description": "Returns the active workspace, or null when no workspace is enabled."
+      },
+      {
+        "name": "setActive",
+        "signature": "setActive(id, [options])",
+        "returns": "this",
+        "description": "Makes another workspace active. An unknown or disabled id changes nothing."
+      },
+      {
+        "name": "setWorkspaces",
+        "signature": "setWorkspaces(workspaces)",
+        "returns": "this",
+        "description": "Replaces the workspaces. The active workspace stays active while it is still listed and enabled; otherwise the first enabled workspace becomes active, silently."
+      },
+      {
+        "name": "setItems",
+        "signature": "setItems(items)",
+        "returns": "this",
+        "description": "Replaces the extra actions after the workspaces."
+      },
+      {
+        "name": "setCompact",
+        "signature": "setCompact(compact)",
+        "returns": "this",
+        "description": "Shows the tile alone, or the tile with the name, secondary line, and chevron — for a navigation column that narrows to icons and widens again. The trigger keeps its full accessible name and gains the workspace name as a tooltip while compact."
+      },
+      {
+        "name": "open",
+        "signature": "open()",
+        "returns": "this",
+        "description": "Opens the menu."
+      },
+      {
+        "name": "close",
+        "signature": "close()",
+        "returns": "this",
+        "description": "Closes the menu."
+      },
+      {
+        "name": "toggle",
+        "signature": "toggle()",
+        "returns": "this",
+        "description": "Toggles the menu."
+      },
+      {
+        "name": "isOpen",
+        "signature": "isOpen()",
+        "returns": "boolean",
+        "description": "Reports whether the menu is open."
+      },
+      {
+        "name": "focus",
+        "signature": "focus()",
+        "returns": "this",
+        "description": "Focuses the trigger."
+      },
+      {
+        "name": "getPanel",
+        "signature": "getPanel()",
+        "returns": "HTMLElement",
+        "description": "Returns the menu panel for shell hover and focus coordination."
+      },
+      {
+        "name": "destroy",
+        "signature": "destroy()",
+        "returns": "void",
+        "description": "Destroys the menu and restores or removes the host."
+      }
+    ]
   }
 }