You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0b2e396
Browse filesBrowse the repository at this point in the historyBrowse files
chore(docs): regenerate references/data/field.mdx on the merged tree (step 4 of the os-regen merge)
Both sides edited the generated field reference: main's #20223 rewrote the
inline grid column prefix/scale rows, this branch removed CurrencyConfig's
precision row and narrowed the currencyConfig type signature.
Claude-Session: https://claude.ai/code/session_01Rjy9MeetSfq34PKn81CRiN
Co-authored-by: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: content/docs/references/data/field.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,7 +205,7 @@ const result = CurrencyConfigSchema.parse(data);
205
205
|**width**|`number`| optional | Fixed column width in px; omitted columns use type-based role sizing (text flexes, numeric/date/select stay fixed). |
206
206
|**required**|`boolean`| optional | Cell is flagged inline-invalid while empty. Computed columns are never required. |
207
207
|**options**|`{ label: string; value: string }[]`| optional | Select-cell options for `type: 'select'`; derived from the child field's options when the column declares no `type`. |
208
-
|**prefix**|`string`| optional |Currency symbol rendered inside a `currency` cell (default '¥'). |
208
+
|**prefix**|`string`| optional |Symbol shown in a `currency` cell in place of the resolved currency's own symbol. No default: when omitted, the cell shows the symbol of the currency it resolves. It replaces the symbol only — the amount's decimal places stay the currency's. |
209
209
|**step**|`number`| optional | Input step for numeric cells. |
210
210
|**reference**|`string`| optional | Referenced object for `type: 'lookup'` cells; derived from the child lookup field when the column declares no `type`. |
211
211
|**displayField**|`string`| optional | Label field shown for a picked lookup record. |
@@ -215,7 +215,7 @@ const result = CurrencyConfigSchema.parse(data);
215
215
|**defaultHidden**|`boolean`| optional | Collapsed into the grid's column chooser by default (not dropped); required columns are never default-hidden. |
216
216
|**computed**|`boolean`| optional | Read-only computed column, recomputed live from sibling cells via `expr` and written back into the row. |
217
217
|**expr**|`string`| optional | Arithmetic expression for a computed column — a BARE string over `+ - * / %`, parentheses, numeric literals and field refs (`record.qty` or `qty`), evaluated by the grid's own safe evaluator. Deliberately NOT a CEL Expression envelope; `{ dialect, source }` is refused here. |
218
-
|**scale**|`integer`| optional | Decimal places to round a computed numeric/currency result to (integer 0-100). The upper bound is the renderer's: the grid rounds with `toFixed`, which throws a RangeError above 100. |
218
+
|**scale**|`integer`| optional | Decimal places to round a computed numeric result to (integer 0-100). REFUSED on a column declaring `type: 'currency'` — delete it there: the currency's ISO 4217 minor unit decides. The upper bound is the renderer's: the grid rounds with `toFixed`, which throws a RangeError above 100. |
219
219
|**autofill**|`boolean`| optional | For `lookup` columns: picking a record copies its same-named fields into sibling columns (a product's unit_price/description). On by default; set false to disable. |
220
220
|**readonlyWhen**|`string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — the cell is read-only when TRUE, evaluated per row against the row as `record` plus the header as `parent` (e.g. P`parent.status == 'paid'`). |
221
221
|**requiredWhen**|`string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — the cell is required when TRUE. Same `record` + `parent` scope as `readonlyWhen`. PRESENTATION ONLY: this flags the cell inline-invalid in the grid; nothing on the write path reads it. The server-enforced contract is the child FIELD's own `requiredWhen` — a transition gate, see `Field.requiredWhen` — which hydration copies onto an identity-only column, so declaring the requirement here alone enforces nothing. |
|**width**|`number`| optional | Fixed column width in px; omitted columns use type-based role sizing (text flexes, numeric/date/select stay fixed). |
355
355
|**required**|`boolean`| optional | Cell is flagged inline-invalid while empty. Computed columns are never required. |
356
356
|**options**|`{ label: string; value: string }[]`| optional | Select-cell options for `type: 'select'`; derived from the child field's options when the column declares no `type`. |
357
-
|**prefix**|`string`| optional |Currency symbol rendered inside a `currency` cell (default '¥'). |
357
+
|**prefix**|`string`| optional |Symbol shown in a `currency` cell in place of the resolved currency's own symbol. No default: when omitted, the cell shows the symbol of the currency it resolves. It replaces the symbol only — the amount's decimal places stay the currency's. |
358
358
|**step**|`number`| optional | Input step for numeric cells. |
359
359
|**reference**|`string`| optional | Referenced object for `type: 'lookup'` cells; derived from the child lookup field when the column declares no `type`. |
360
360
|**displayField**|`string`| optional | Label field shown for a picked lookup record. |
|**defaultHidden**|`boolean`| optional | Collapsed into the grid's column chooser by default (not dropped); required columns are never default-hidden. |
365
365
|**computed**|`boolean`| optional | Read-only computed column, recomputed live from sibling cells via `expr` and written back into the row. |
366
366
|**expr**|`string`| optional | Arithmetic expression for a computed column — a BARE string over `+ - * / %`, parentheses, numeric literals and field refs (`record.qty` or `qty`), evaluated by the grid's own safe evaluator. Deliberately NOT a CEL Expression envelope; `{ dialect, source }` is refused here. |
367
-
|**scale**|`integer`| optional | Decimal places to round a computed numeric/currency result to (integer 0-100). The upper bound is the renderer's: the grid rounds with `toFixed`, which throws a RangeError above 100. |
367
+
|**scale**|`integer`| optional | Decimal places to round a computed numeric result to (integer 0-100). REFUSED on a column declaring `type: 'currency'` — delete it there: the currency's ISO 4217 minor unit decides. The upper bound is the renderer's: the grid rounds with `toFixed`, which throws a RangeError above 100. |
368
368
|**autofill**|`boolean`| optional | For `lookup` columns: picking a record copies its same-named fields into sibling columns (a product's unit_price/description). On by default; set false to disable. |
369
369
|**readonlyWhen**|`string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — the cell is read-only when TRUE, evaluated per row against the row as `record` plus the header as `parent` (e.g. P`parent.status == 'paid'`). |
370
370
|**requiredWhen**|`string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Predicate (CEL) — the cell is required when TRUE. Same `record` + `parent` scope as `readonlyWhen`. PRESENTATION ONLY: this flags the cell inline-invalid in the grid; nothing on the write path reads it. The server-enforced contract is the child FIELD's own `requiredWhen` — a transition gate, see `Field.requiredWhen` — which hydration copies onto an identity-only column, so declaring the requirement here alone enforces nothing. |
0 commit comments