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 be64fe6
Browse filesBrowse the repository at this point in the historyBrowse files
Merge hand-off: regenerate content/docs/references/ui/component.mdx from the merged tree
origin/main (287fd6e) brought PR #23101's component rows; the branch's
retirement removes the view-level api arm from the same page. Regenerated
with gen:docs on the merged tree per scripts/pm/os-regen-merge.sh step 4.
Claude-Session: https://claude.ai/code/session_01BRQ9Mp1yH7R1az6MaUM18H
Co-authored-by: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: content/docs/references/ui/component.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
@@ -38,7 +38,7 @@ const result = ActionButtonPropsSchema.parse(data);
38
38
|**disabled**|`boolean \| string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Disabled predicate — a boolean, a CEL string, or a `{ dialect, source }` envelope; the button is shown but cannot be pressed while it is TRUE. Omit for never-disabled |
39
39
|**params**|`any`| optional | Action parameters, forwarded to the runner: an array is the list of inputs to collect from the user before the action runs; an object is forwarded as the static parameter values |
40
40
|**description**|`string`| optional | Action description, forwarded to the runner — the parameter dialog shows it under its title |
41
-
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`|
41
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`. For `actionType: 'url'`: an http:// or https:// URL, a mailto: address, or an in-app path starting with / or ./ — every other scheme and a protocol-relative //host are refused|
42
42
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
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 |
@@ -89,7 +89,7 @@ const result = ActionButtonPropsSchema.parse(data);
89
89
|**tags**|`Enum<'separator-before'>[]`| optional | Item tags — `separator-before` draws a divider above the item in a dropdown or menu (not above the first item); no other tag is drawn |
90
90
|**params**|`any`| optional | Action parameters, forwarded to the runner: an array is the list of inputs to collect from the user before the action runs. Only a `type: 'api'` member takes any other value, forwarded as its request payload (use `bodyExtra` for that); on every other member a non-array `params` is refused — author an action with static parameter values as its own `action:button` node |
91
91
|**description**|`string`| optional | Action description, forwarded to the runner — the parameter dialog shows it under its title |
92
-
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`|
92
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`. For `type: 'url'`: an http:// or https:// URL, a mailto: address, or an in-app path starting with / or ./ — every other scheme and a protocol-relative //host are refused|
93
93
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
94
94
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
95
95
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
@@ -125,7 +125,7 @@ const result = ActionButtonPropsSchema.parse(data);
125
125
|**disabled**|`boolean \| string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source: string; ast?: any; meta?: object }`| optional | Disabled predicate — a boolean, a CEL string, or a `{ dialect, source }` envelope; the icon is shown but cannot be pressed while it is TRUE. Omit for never-disabled |
126
126
|**description**|`string`| optional | Action description — the tooltip text when there is no `label`, and forwarded to the runner for the parameter dialog |
127
127
|**params**|`any`| optional | Action parameters, forwarded to the runner: an array is the list of inputs to collect from the user; an object is forwarded as the static parameter values |
128
-
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`|
128
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`. For `actionType: 'url'`: an http:// or https:// URL, a mailto: address, or an in-app path starting with / or ./ — every other scheme and a protocol-relative //host are refused|
129
129
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
130
130
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
131
131
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
@@ -172,7 +172,7 @@ const result = ActionButtonPropsSchema.parse(data);
172
172
|**tags**|`Enum<'separator-before'>[]`| optional | Item tags — `separator-before` draws a divider above the item in a dropdown or menu (not above the first item); no other tag is drawn |
173
173
|**params**|`any`| optional | Action parameters, forwarded to the runner: an array is the list of inputs to collect from the user before the action runs. Only a `type: 'api'` member takes any other value, forwarded as its request payload (use `bodyExtra` for that); on every other member a non-array `params` is refused — author an action with static parameter values as its own `action:button` node |
174
174
|**description**|`string`| optional | Action description, forwarded to the runner — the parameter dialog shows it under its title |
175
-
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`|
175
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`. For `type: 'url'`: an http:// or https:// URL, a mailto: address, or an in-app path starting with / or ./ — every other scheme and a protocol-relative //host are refused|
176
176
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
177
177
|**method**|`string`| optional | HTTP method for an `api` action, forwarded to the runner |
178
178
|**bodyExtra**|`any`| optional | Static request-body fields for an `api` action, forwarded to the runner |
0 commit comments