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 19b5670
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: content/docs/references/ui/component.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ const result = ActionButtonPropsSchema.parse(data);
43
43
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
44
44
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
45
45
|**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|
47
47
|**patch**|`any`| optional | Field values the declarative `operation` writes, forwarded to the runner |
48
48
|**confirmText**|`string`| optional | Confirmation question asked before the action runs |
49
49
|**successMessage**|`string`| optional | Toast shown when the action succeeds |
@@ -54,7 +54,7 @@ const result = ActionButtonPropsSchema.parse(data);
54
54
|**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 |
55
55
|**toast**|`any`| optional | Toast behaviour, forwarded to the runner |
56
56
|**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 ${, 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 ${, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab`|
58
58
|**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 |
59
59
60
60
### Nested Shape: `ActionButtonProps.onSuccess`
@@ -101,7 +101,7 @@ const result = ActionButtonPropsSchema.parse(data);
101
101
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
102
102
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
103
103
|**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|
105
105
|**patch**|`any`| optional | Field values the declarative `operation` writes, forwarded to the runner |
106
106
|**confirmText**|`string`| optional | Confirmation question asked before the action runs |
107
107
|**successMessage**|`string`| optional | Toast shown when the action succeeds |
@@ -110,7 +110,7 @@ const result = ActionButtonPropsSchema.parse(data);
110
110
|**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 |
111
111
|**toast**|`any`| optional | Toast behaviour, forwarded to the runner |
112
112
|**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 ${, 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 ${, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab`|
114
114
|**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 |
115
115
|**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 |
116
116
@@ -137,7 +137,7 @@ const result = ActionButtonPropsSchema.parse(data);
137
137
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
138
138
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
139
139
|**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|
141
141
|**patch**|`any`| optional | Field values the declarative `operation` writes, forwarded to the runner |
142
142
|**confirmText**|`string`| optional | Confirmation question asked before the action runs |
143
143
|**successMessage**|`string`| optional | Toast shown when the action succeeds |
@@ -146,7 +146,7 @@ const result = ActionButtonPropsSchema.parse(data);
146
146
|**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 |
147
147
|**toast**|`any`| optional | Toast behaviour, forwarded to the runner |
148
148
|**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 ${, 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 ${, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab`|
150
150
|**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 |
151
151
152
152
### Nested Shape: `ActionIconProps.onSuccess`
@@ -191,7 +191,7 @@ const result = ActionButtonPropsSchema.parse(data);
191
191
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
192
192
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
193
193
|**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|
195
195
|**patch**|`any`| optional | Field values the declarative `operation` writes, forwarded to the runner |
196
196
|**confirmText**|`string`| optional | Confirmation question asked before the action runs |
197
197
|**successMessage**|`string`| optional | Toast shown when the action succeeds |
@@ -200,7 +200,7 @@ const result = ActionButtonPropsSchema.parse(data);
200
200
|**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 |
201
201
|**toast**|`any`| optional | Toast behaviour, forwarded to the runner |
202
202
|**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 ${, 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 ${, judged after interpolation — every other scheme and a protocol-relative //host are refused; `openIn` is `self` (default) or `newTab`|
204
204
|**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 |
0 commit comments