Skip to content

Commit 8b27675

Browse files
committed
chore(spec): regenerate the component reference page for the columns hold (#21464 stage 2)
Claude-Session: https://claude.ai/code/session_01YDt3PzwfrkuFzUBF89WPmM Co-authored-by: Claude <noreply@anthropic.com>
1 parent d3a5b3a commit 8b27675

1 file changed

Lines changed: 1 addition & 20 deletions

File tree

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

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ Sort field and direction pair
692692
| **title** | `string \| Record<string, string>` | optional | Fallback for `label` (the renderer reads `label \|\| title`) |
693693
| **description** | `string \| Record<string, string>` | optional | One line of help text drawn above the grid's rows — a string, or an inline locale map resolved against the display locale |
694694
| **emptyState** | `{ title?: string \| Record<string, string>; message?: string \| Record<string, string>; icon?: string }` | optional | What the grid draws instead of an empty table: `{ title, message, icon }` — the list view's own empty-state shape |
695-
| **columns** | `string[] \| { field: string; label?: string \| Record<string, string>; width?: number; align?: Enum<'left' \| 'center' \| 'right'>; … }[]` | optional | Columns — all field-name strings, or all column entries `{ field, label?, width?, align?, hidden?, sortable?, … }`, the same union a list view's `columns` declares. One spelling per list: an array mixing strings and column objects is refused |
695+
| **columns** | `any[]` | optional | Columns: field names or column definition objects |
696696
| **fields** | `string[]` | optional | Field-name fallback the grid reads when `columns` is absent — bare field names (`['name', 'amount']`); write column decoration such as `label` or `width` on `columns` |
697697
| **filter** | `{ field: string; operator: Enum<'equals' \| 'not_equals' \| 'contains' \| 'not_contains' \| 'icontains' \| …>; value?: string \| number \| boolean \| null \| (string \| number)[] }[]` | optional | Base query filter — the ViewFilterRule array form `[{ field, operator, value }, ...]`, the one filter orthography every `filter` door in this map shares; lowered to the wire `$filter`. THE key, singular — not the plural misspelling. The MongoDB-style record form is refused — see migration `element-data-source-and-object-block-filter-rule-array` |
698698
| **defaultFilters** | `{ field: string; operator: Enum<'equals' \| 'not_equals' \| 'contains' \| 'not_contains' \| 'icontains' \| …>; value?: string \| number \| boolean \| null \| (string \| number)[] }[]` | optional | Legacy base-filter fallback, read only when `filter` is absent — the SAME ViewFilterRule array form `[{ field, operator, value }, ...]` as `filter`, lowered through the same sink. Prefer `filter`. The MongoDB-style record form, a bare string and an ObjectQL AST tuple array are refused — see migration `object-grid-default-filters-rule-array` |
@@ -736,25 +736,6 @@ Sort field and direction pair
736736
| **message** | `string \| Record<string, string>` | optional | Line of text below the heading |
737737
| **icon** | `string` | optional | Icon name drawn above the heading; a name that resolves to no icon draws the default empty-state glyph |
738738

739-
### Nested Shape: `ObjectGridProps.columns[number]`
740-
741-
| Property | Type | Required | Description |
742-
| :--- | :--- | :--- | :--- |
743-
| **field** | `string` | ✅ | Field name (snake_case) |
744-
| **label** | `string \| Record<string, string>` | optional | Display label override |
745-
| **width** | `number` | optional | Column width in pixels |
746-
| **align** | `Enum<'left' \| 'center' \| 'right'>` | optional | Text alignment |
747-
| **hidden** | `boolean` | optional | Hide column by default |
748-
| **sortable** | `boolean` | optional | Allow sorting by this column |
749-
| **resizable** | `boolean` | optional | Allow resizing this column |
750-
| **wrap** | `boolean` | optional | Allow text wrapping |
751-
| **type** | `string` | optional | Renderer type override (e.g., "currency", "date") |
752-
| **pinned** | `Enum<'left' \| 'right'>` | optional | Pin/freeze column to left or right side |
753-
| **summary** | `Enum<'none' \| 'count' \| 'count_empty' \| 'count_filled' \| 'count_unique' \| …> \| { type: Enum<'none' \| 'count' \| 'count_empty' \| 'count_filled' \| 'count_unique' \| …>; field?: string }` | optional | Footer aggregation for this column — the function alone, or `{ type, field }` to aggregate another field |
754-
| **prefix** | `{ field: string; type?: Enum<'badge' \| 'text'> }` | optional | Field rendered inline before this cell value |
755-
| **link** | `boolean` | optional | Functions as the primary navigation link (triggers View navigation) |
756-
| **action** | `string` | optional | Registered Action ID to execute when clicked |
757-
758739
### Nested Shape: `ObjectGridProps.filter[number]`
759740

760741
View filter rule

0 commit comments

Comments
 (0)