Skip to content

Commit 19b5670

Browse files
committed
docs(spec): regenerate the component reference for the row operation
Claude-Session: https://claude.ai/code/session_01D6F9axfoPzR7t8G1J7Ytzz Co-authored-by: Claude <noreply@anthropic.com>
1 parent 9f2bd76 commit 19b5670

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const result = ActionButtonPropsSchema.parse(data);
4343
| **method** | `string` | optional | HTTP method for an `api` action, forwarded to the runner |
4444
| **bodyExtra** | `any` | optional | Static request-body fields for an `api` action, forwarded to the runner |
4545
| **bodyShape** | `any` | optional | How an `api` action shapes its request body, forwarded to the runner |
46-
| **operation** | `any` | optional | Declarative single-record write, forwarded to the runner together with `patch` |
46+
| **operation** | `Enum<'update'>` | optional | Declarative single-record write, forwarded to the runner together with `patch`: `ActionSchema`'s own `operation`, whose one member is `update`. The runner reads it before any executor, performs the write through the platform action route and runs no executor of its own |
4747
| **patch** | `any` | optional | Field values the declarative `operation` writes, forwarded to the runner |
4848
| **confirmText** | `string` | optional | Confirmation question asked before the action runs |
4949
| **successMessage** | `string` | optional | Toast shown when the action succeeds |
@@ -54,7 +54,7 @@ const result = ActionButtonPropsSchema.parse(data);
5454
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| 'record_related' \| 'record_section'>[]` | optional | Action locations, forwarded to the runner — the console uses them to tell a record-scoped action from an object-level one |
5555
| **toast** | `any` | optional | Toast behaviour, forwarded to the runner |
5656
| **resultDialog** | `any` | optional | One-shot result dialog for a value the response shows exactly once, forwarded to the runner |
57-
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, and on a row that names no executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
57+
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, on a row that names no executor, and beside `operation: 'update'`, whose write the runner performs before any executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
5858
| **objectName** | `string` | optional | Object the action acts on, forwarded to the runner — the console dispatches to it instead of the page's object. Omit to act on the page's object |
5959

6060
### Nested Shape: `ActionButtonProps.onSuccess`
@@ -101,7 +101,7 @@ const result = ActionButtonPropsSchema.parse(data);
101101
| **method** | `string` | optional | HTTP method for an `api` action, forwarded to the runner |
102102
| **bodyExtra** | `any` | optional | Static request-body fields for an `api` action, forwarded to the runner |
103103
| **bodyShape** | `any` | optional | How an `api` action shapes its request body, forwarded to the runner |
104-
| **operation** | `any` | optional | Declarative single-record write, forwarded to the runner together with `patch` |
104+
| **operation** | `Enum<'update'>` | optional | Declarative single-record write, forwarded to the runner together with `patch`: `ActionSchema`'s own `operation`, whose one member is `update`. The runner reads it before any executor, performs the write through the platform action route and runs no executor of its own |
105105
| **patch** | `any` | optional | Field values the declarative `operation` writes, forwarded to the runner |
106106
| **confirmText** | `string` | optional | Confirmation question asked before the action runs |
107107
| **successMessage** | `string` | optional | Toast shown when the action succeeds |
@@ -110,7 +110,7 @@ const result = ActionButtonPropsSchema.parse(data);
110110
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| …>[]` | optional | Action locations, forwarded to the runner — an `action:group` with a `location` draws only the members that list it, and the console uses them to tell a record-scoped action from an object-level one |
111111
| **toast** | `any` | optional | Toast behaviour, forwarded to the runner |
112112
| **resultDialog** | `any` | optional | One-shot result dialog for a value the response shows exactly once, forwarded to the runner |
113-
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, and on a row that names no executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
113+
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, on a row that names no executor, and beside `operation: 'update'`, whose write the runner performs before any executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
114114
| **objectName** | `string` | optional | Object the action acts on, forwarded to the runner — the console dispatches to it instead of the page's object. Omit to act on the page's object |
115115
| **size** | `Enum<'default' \| 'sm' \| 'lg' \| 'icon' \| 'md'>` | optional | Inline button size — the Button primitive's vocabulary, plus `md` (drawn as `default`), falling back to the group's `size`. A dropdown item reads no size |
116116

@@ -137,7 +137,7 @@ const result = ActionButtonPropsSchema.parse(data);
137137
| **method** | `string` | optional | HTTP method for an `api` action, forwarded to the runner |
138138
| **bodyExtra** | `any` | optional | Static request-body fields for an `api` action, forwarded to the runner |
139139
| **bodyShape** | `any` | optional | How an `api` action shapes its request body, forwarded to the runner |
140-
| **operation** | `any` | optional | Declarative single-record write, forwarded to the runner together with `patch` |
140+
| **operation** | `Enum<'update'>` | optional | Declarative single-record write, forwarded to the runner together with `patch`: `ActionSchema`'s own `operation`, whose one member is `update`. The runner reads it before any executor, performs the write through the platform action route and runs no executor of its own |
141141
| **patch** | `any` | optional | Field values the declarative `operation` writes, forwarded to the runner |
142142
| **confirmText** | `string` | optional | Confirmation question asked before the action runs |
143143
| **successMessage** | `string` | optional | Toast shown when the action succeeds |
@@ -146,7 +146,7 @@ const result = ActionButtonPropsSchema.parse(data);
146146
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| 'record_related' \| 'record_section'>[]` | optional | Action locations, forwarded to the runner — the console uses them to tell a record-scoped action from an object-level one |
147147
| **toast** | `any` | optional | Toast behaviour, forwarded to the runner |
148148
| **resultDialog** | `any` | optional | One-shot result dialog for a value the response shows exactly once, forwarded to the runner |
149-
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, and on a row that names no executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
149+
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, on a row that names no executor, and beside `operation: 'update'`, whose write the runner performs before any executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
150150
| **objectName** | `string` | optional | Object the action acts on, forwarded to the runner — the console dispatches to it instead of the page's object. Omit to act on the page's object |
151151

152152
### Nested Shape: `ActionIconProps.onSuccess`
@@ -191,7 +191,7 @@ const result = ActionButtonPropsSchema.parse(data);
191191
| **method** | `string` | optional | HTTP method for an `api` action, forwarded to the runner |
192192
| **bodyExtra** | `any` | optional | Static request-body fields for an `api` action, forwarded to the runner |
193193
| **bodyShape** | `any` | optional | How an `api` action shapes its request body, forwarded to the runner |
194-
| **operation** | `any` | optional | Declarative single-record write, forwarded to the runner together with `patch` |
194+
| **operation** | `Enum<'update'>` | optional | Declarative single-record write, forwarded to the runner together with `patch`: `ActionSchema`'s own `operation`, whose one member is `update`. The runner reads it before any executor, performs the write through the platform action route and runs no executor of its own |
195195
| **patch** | `any` | optional | Field values the declarative `operation` writes, forwarded to the runner |
196196
| **confirmText** | `string` | optional | Confirmation question asked before the action runs |
197197
| **successMessage** | `string` | optional | Toast shown when the action succeeds |
@@ -200,7 +200,7 @@ const result = ActionButtonPropsSchema.parse(data);
200200
| **locations** | `Enum<'list_toolbar' \| 'list_item' \| 'record_header' \| 'record_more' \| …>[]` | optional | Action locations, forwarded to the runner — an `action:group` with a `location` draws only the members that list it, and the console uses them to tell a record-scoped action from an object-level one |
201201
| **toast** | `any` | optional | Toast behaviour, forwarded to the runner |
202202
| **resultDialog** | `any` | optional | One-shot result dialog for a value the response shows exactly once, forwarded to the runner |
203-
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, and on a row that names no executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
203+
| **onSuccess** | `{ navigate: string; openIn?: Enum<'self' \| 'newTab'> }` | optional | Post-success navigation, forwarded to the runner: `ActionSchema`'s own `{ navigate, openIn }` block. Taken beside an `api` or `script` executor, or a handler a host registers under another name; refused beside the built-ins `url`, `navigation`, `modal`, `flow` and `form`, on a row that names no executor, and beside `operation: 'update'`, whose write the runner performs before any executor. `navigate` is an http:// or https:// URL, a mailto: address, an in-app path starting with / or ./, or a template that opens with $&#123;, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab` |
204204
| **objectName** | `string` | optional | Object the action acts on, forwarded to the runner — the console dispatches to it instead of the page's object. Omit to act on the page's object |
205205

206206

0 commit comments

Comments
 (0)