Skip to content

Commit 74ea5db

Browse files
committed
docs(spec): regenerate the ui/view reference for the narrowed options describe
Generator output only (pnpm --filter @objectstack/spec gen:docs after a spec build): the two FormField options rows. Against the merged main tip the page differs in exactly those two rows. Claude-Session: https://claude.ai/code/session_013RDBh5DqXd2xnLwvHLgLFr Co-authored-by: Claude <noreply@anthropic.com>
1 parent 182ed4c commit 74ea5db

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Column footer summary configuration
181181
| :--- | :--- | :--- | :--- |
182182
| **field** | `string` | ✅ | Field name (snake_case) |
183183
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'secret' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| … +35 more>` | optional | Field type (auto-infers widget if omitted) |
184-
| **options** | `{ label: string; value: string; description?: string; color?: string; … }[]` | optional | Options for select/multiselect/radio/checkboxes fields (per-option `default` is not accepted here — declare the pre-selected choice on the object definition). On a metadata form (schema-bound, built by `defineForm`), a row whose key is a spec enum omits `options`: the control derives the members from the served JSON Schema, and their meanings go in `helpText`. An option `value` is a lowercase system identifier, so an enum member carrying a hyphen or a capital cannot be listed here at all. |
184+
| **options** | `{ label: string; value: string; description?: string; color?: string; … }[]` | optional | Options for select/multiselect/radio/checkboxes fields (per-option `default` is not accepted here — declare the pre-selected choice on the object definition). On a metadata form (schema-bound, built by `defineForm`), an enum-typed row may list its members here, to give them human labels or to offer a deliberate subset. An option `value` is a lowercase system identifier, so a row whose members cannot be spelled as option values (a hyphen, a capital) omits `options`: the control derives the members from the served JSON Schema, and their meanings go in `helpText`. |
185185
| **reference** | `string` | optional | Target object name for lookup/master_detail fields |
186186
| **publicPicker** | `{ displayFields?: string[]; maxResults?: integer; filter?: object[]; object?: string }` | optional | Opt this field into the anonymous public-form lookup picker (GET /forms/:slug/lookup/:field). Without it the route answers 403 LOOKUP_NOT_PUBLIC and the field is stripped from the rendered public form. |
187187
| **maxLength** | `integer` | optional | Maximum character length (positive integer; for text/textarea/email/url/phone) |
@@ -346,7 +346,7 @@ View filter rule
346346
| :--- | :--- | :--- | :--- |
347347
| **field** | `string` | ✅ | Field name (snake_case) |
348348
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'secret' \| …>` | optional | Field type (auto-infers widget if omitted) |
349-
| **options** | `{ label: string; value: string; description?: string; color?: string; … }[]` | optional | Options for select/multiselect/radio/checkboxes fields (per-option `default` is not accepted here — declare the pre-selected choice on the object definition). On a metadata form (schema-bound, built by `defineForm`), a row whose key is a spec enum omits `options`: the control derives the members from the served JSON Schema, and their meanings go in `helpText`. An option `value` is a lowercase system identifier, so an enum member carrying a hyphen or a capital cannot be listed here at all. |
349+
| **options** | `{ label: string; value: string; description?: string; color?: string; … }[]` | optional | Options for select/multiselect/radio/checkboxes fields (per-option `default` is not accepted here — declare the pre-selected choice on the object definition). On a metadata form (schema-bound, built by `defineForm`), an enum-typed row may list its members here, to give them human labels or to offer a deliberate subset. An option `value` is a lowercase system identifier, so a row whose members cannot be spelled as option values (a hyphen, a capital) omits `options`: the control derives the members from the served JSON Schema, and their meanings go in `helpText`. |
350350
| **reference** | `string` | optional | Target object name for lookup/master_detail fields |
351351
| **publicPicker** | `{ displayFields?: string[]; maxResults?: integer; filter?: object[]; object?: string }` | optional | Opt this field into the anonymous public-form lookup picker (GET /forms/:slug/lookup/:field). Without it the route answers 403 LOOKUP_NOT_PUBLIC and the field is stripped from the rendered public form. |
352352
| **maxLength** | `integer` | optional | Maximum character length (positive integer; for text/textarea/email/url/phone) |

0 commit comments

Comments
 (0)