Skip to content

Commit 09f4234

Browse files
os-zhuangclaude
andcommitted
docs: teach highlightFields/stageField in place of compactLayout (ADR-0085)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent c94dd94 commit 09f4234

4 files changed

Lines changed: 7 additions & 6 deletions

File tree

content/docs/guides/data-modeling.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export const MyObject = ObjectSchema.create({
3939

4040
// Display configuration
4141
titleFormat: '{{record.field1}} - {{record.field2}}',
42-
compactLayout: ['field1', 'field2', 'field3'],
42+
highlightFields: ['field1', 'field2', 'field3'],
4343

4444
// Fields definition
4545
fields: {
@@ -67,7 +67,7 @@ export const MyObject = ObjectSchema.create({
6767
| `icon` | string | Icon identifier | `'building'` |
6868
| `description` | string | Help text | `'Companies...'` |
6969
| `titleFormat` | string | Record title template (`{{record.field}}` interpolation) | `'{{record.name}} - {{record.id}}'` |
70-
| `compactLayout` | string[] | Quick view fields | `['name', 'status']` |
70+
| `highlightFields` | string[] | Most-important fields, in priority order (default columns, cards, previews, detail highlight strip; ADR-0085 — formerly `compactLayout`, still accepted as an alias) | `['name', 'status']` |
7171

7272
### Enable Features
7373

content/docs/guides/metadata/object.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ export const Account = ObjectSchema.create({
6868
| :--- | :--- | :--- | :--- |
6969
| `displayNameField` | `string` | optional | Field used as record display name (defaults to `'name'`) |
7070
| `titleFormat` | `string` | optional | Title expression (e.g. `'{name} - {code}'`) |
71-
| `compactLayout` | `string[]` | optional | Primary fields for hover cards and lookups |
71+
| `highlightFields` | `string[]` | optional | Most-important fields in priority order — default list columns, cards, previews, detail highlight strip (ADR-0085; formerly `compactLayout`, accepted as an alias) |
72+
| `stageField` | `string \| false` | optional | Linear lifecycle field; `false` declares the status field non-linear and suppresses stage heuristics (ADR-0085) |
7273
| `recordName` | `object` | optional | Record name auto-generation config |
7374

7475
### Capabilities (`enable`)

content/docs/guides/standards.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ export const MyObject = ObjectSchema.create({
9595

9696
// ✅ Display Configuration
9797
titleFormat: '{field1} - {field2}',
98-
compactLayout: ['field1', 'field2', 'field3'],
98+
highlightFields: ['field1', 'field2', 'field3'],
9999

100100
// ✅ Fields Definition
101101
fields: {

content/docs/references/ui/component.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,9 @@ const result = AIChatWindowProps.parse(data);
274274
| Property | Type | Required | Description |
275275
| :--- | :--- | :--- | :--- |
276276
| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` || Number of columns for field layout (1-4) |
277-
| **layout** | `Enum<'auto' \| 'custom'>` || Layout mode: auto uses object compactLayout, custom uses explicit sections |
277+
| **layout** | `Enum<'auto' \| 'custom'>` || Layout mode: auto uses object highlightFields (formerly compactLayout), custom uses explicit sections |
278278
| **sections** | `string[]` | optional | Section IDs to show (required when layout is "custom") |
279-
| **fields** | `string[]` | optional | Explicit field list to display (optional, overrides compactLayout) |
279+
| **fields** | `string[]` | optional | Explicit field list to display (optional, overrides highlightFields) |
280280
| **aria** | `Object` | optional | ARIA accessibility attributes |
281281

282282

0 commit comments

Comments
 (0)