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 b76c26a
Browse filesBrowse the repository at this point in the historyBrowse files
feat(spec)!: a page action row's url `target` is judged on the executor the console's action runner actually runs, so a row with no executor key whose `name` is `url` or `navigation` has its `target` judged by the url scheme set
**BREAKING**: an accept-set narrowing on one key of four published page component rows, shipped as `minor` under the launch-window convention for accept-set narrowings.
12
+
13
+
The page action rows are `action:button` and `action:icon` (`properties`), and each member of an `action:group` or `action:menu` (`properties.actions[]`). The console's action runner dispatches a row on `type || actionType || name`, and every row forwards its executor key (`actionType` on a node, `type` on a member) as `type` beside its `name`. So a row with no executor key runs the handler its `name` names, and `name: 'url'` or `name: 'navigation'` runs the url navigator. The rows judged `target` by the url scheme set only when the executor KEY read `'url'`, so such a row parsed with a target the click refuses.
14
+
15
+
The rows now judge `target` against the row's effective executor: the executor key, or, when that key is omitted or empty, the `name`, exactly as the runner resolves it. When it resolves to the url navigator, `target` is judged by the same url scheme set as an `actionType: 'url'` row, with no second grammar. A declared executor key still outranks the `name`. `name` is not refused as an executor spelling, and a row whose `name` names any other handler (`navigate_edit`, `convert_lead`, …) is untouched. An `actionType: 'url'` row's refusal is unchanged.
16
+
17
+
### FROM → TO
18
+
19
+
| before | what to write instead |
20
+
| --- | --- |
21
+
|`{ name: 'url', target: 'javascript:…' }` with no `actionType` (or no `type` on a member), or `data:…`, `tel:…` or any other scheme | an `https://` page, a `mailto:` address, or an in-app path that starts with `/` or `./`; or, for a button meant to run something, the executor that does the work (`actionType: 'script'`, `'flow'`, `'api'`) |
22
+
| the same with `name: 'navigation'`| the same; the `name` is the runner's url alias, so the target is judged as a url |
23
+
|`{ name: 'url', target: 'forecast' }`, `'../forecast'`, `'?tab=2'`| the rooted in-app path, `'/forecast'`, or a `./` path; or declare the executor the row was meant to run |
24
+
|`{ name: 'url', target: '//cdn.example.com/x' }`|`'https://cdn.example.com/x'`, or `'/x'` for an in-app path |
25
+
|`{ name: 'url', target: '' }`| the address the button was meant to open |
26
+
27
+
**The one-line fix: give every page action row that has no executor key and is named `url` or `navigation` an `http(s)://` URL, a `mailto:` address, an in-app path that starts with `/` or `./`, or a template that opens with `${` as its `target`, or declare the executor key it was meant to run.**`os migrate meta --from 17` lists the D3 entry `ui-page-action-row-name-leg-url-target-judged`; the rewrite is by hand, because which address a refused target meant is the author's call.
28
+
29
+
**What an author now sees.**`os validate`'s props gate reports the refusal at the row's `target` (`properties.target`, or `properties.actions.N.target` for a member). For example, `{ name: 'url', target: 'javascript:alert(1)' }` on an `action:button` gets: ``An `action:button`'s `target` (`name: 'url'` and no `actionType`, so the runner runs the url navigator) opens with `javascript:`, a scheme a url target never opens.``, followed by the reason and the admitted set. Every admitted target parses unchanged.
30
+
31
+
**Measured producers: none.** No page action row in this repository, in objectui (at its pin `1fb1ced36243` and its main `866763bd`) or in hotcrm (at `0f84c9c`) is named `url` or `navigation`.
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
@@ -28,7 +28,7 @@ const result = ActionButtonPropsSchema.parse(data);
28
28
29
29
| Property | Type | Required | Description |
30
30
| :--- | :--- | :--- | :--- |
31
-
|**name**|`string`| optional | Action name, forwarded to the action runner. Optional: an inline page button is not a registered object action, and without a name the runner dispatches on `actionType` alone |
31
+
|**name**|`string`| optional | Action name, forwarded to the action runner. Optional: an inline page button is not a registered object action, and without a name the runner dispatches on `actionType` alone. With no `actionType` the runner dispatches on the name instead, so a `name` of `url` or `navigation` runs the url navigator and its `target` is judged as a url target|
32
32
|**label**|`string`| optional | Button text. A literal string, placed as-is — localize through the translation bundle entry for this component id, not an inline locale map |
33
33
|**icon**|`string`| optional | Lucide icon name drawn left of the label, resolved through the shared action-icon resolver (an unknown name draws no icon) |
34
34
|**actionType**|`string`| optional | Executor the action runner dispatches to — built in: `script`, `url`, `modal`, `flow`, `api`, `form`; a handler registered under another name is dispatched too. `navigation`, the runner's alias of `url`, is refused: write `url`. Write it here, not as `type`: on a page component `type` is the component itself |
@@ -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`. 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 |
41
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`. For the url navigator (`actionType: 'url'`, or no `actionType` and a `name` of `url` or `navigation`): 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 |
@@ -86,7 +86,7 @@ const result = ActionButtonPropsSchema.parse(data);
86
86
87
87
| Property | Type | Required | Description |
88
88
| :--- | :--- | :--- | :--- |
89
-
|**name**|`string`| optional | Action name, forwarded to the action runner, and the item's text when there is no `label`. Optional: a member is not a registered object action, and the runner dispatches a nameless one on its `type`|
89
+
|**name**|`string`| optional | Action name, forwarded to the action runner, and the item's text when there is no `label`. Optional: a member is not a registered object action, and the runner dispatches a nameless one on its `type`. With no `type` the runner dispatches on the name instead, so a `name` of `url` or `navigation` runs the url navigator and its `target` is judged as a url target|
90
90
|**label**|`string`| optional | The item's text. A literal string, placed as-is — localize through the translation bundle entry for this component id |
91
91
|**icon**|`string`| optional | Lucide icon name drawn before the label, resolved through the shared action-icon resolver (an unknown name draws no icon) |
92
92
|**type**|`string`| optional | Executor the action runner dispatches to — built in: `script`, `url`, `modal`, `flow`, `api`, `form`; a handler registered under another name is dispatched too. `navigation`, the runner's alias of `url`, is refused: write `url`. A member is an action entry, so its executor is `type` (on an `action:button` node it is `actionType`) |
@@ -96,7 +96,7 @@ const result = ActionButtonPropsSchema.parse(data);
96
96
|**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 |
97
97
|**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 |
98
98
|**description**|`string`| optional | Action description, forwarded to the runner — the parameter dialog shows it under its title |
99
-
|**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 |
99
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`. For the url navigator (`type: 'url'`, or no `type` and a `name` of `url` or `navigation`): 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 |
100
100
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
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 |
@@ -123,7 +123,7 @@ const result = ActionButtonPropsSchema.parse(data);
123
123
124
124
| Property | Type | Required | Description |
125
125
| :--- | :--- | :--- | :--- |
126
-
|**name**|`string`| optional | Action name, forwarded to the action runner; also the `aria-label` when there is no `label`. Optional, as for `action:button`|
126
+
|**name**|`string`| optional | Action name, forwarded to the action runner; also the `aria-label` when there is no `label`. Optional, as for `action:button`. With no `actionType` the runner dispatches on the name instead, so a `name` of `url` or `navigation` runs the url navigator and its `target` is judged as a url target|
127
127
|**label**|`string`| optional | Accessible label and tooltip text (and its first letter stands in when no icon resolves). A literal string — localize through the translation bundle entry for this component id |
128
128
|**icon**|`string`| optional | Lucide icon name, resolved through the shared action-icon resolver (renderer registration default `play`) |
129
129
|**actionType**|`string`| optional | Executor the action runner dispatches to — built in: `script`, `url`, `modal`, `flow`, `api`, `form`; a handler registered under another name is dispatched too. `navigation`, the runner's alias of `url`, is refused: write `url`. Write it here, not as `type`|
@@ -132,7 +132,7 @@ const result = ActionButtonPropsSchema.parse(data);
132
132
|**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 |
133
133
|**description**|`string`| optional | Action description — the tooltip text when there is no `label`, and forwarded to the runner for the parameter dialog |
134
134
|**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 |
135
-
|**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 |
135
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `actionType`. For the url navigator (`actionType: 'url'`, or no `actionType` and a `name` of `url` or `navigation`): 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 |
136
136
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
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 |
@@ -176,7 +176,7 @@ const result = ActionButtonPropsSchema.parse(data);
176
176
177
177
| Property | Type | Required | Description |
178
178
| :--- | :--- | :--- | :--- |
179
-
|**name**|`string`| optional | Action name, forwarded to the action runner, and the item's text when there is no `label`. Optional: a member is not a registered object action, and the runner dispatches a nameless one on its `type`|
179
+
|**name**|`string`| optional | Action name, forwarded to the action runner, and the item's text when there is no `label`. Optional: a member is not a registered object action, and the runner dispatches a nameless one on its `type`. With no `type` the runner dispatches on the name instead, so a `name` of `url` or `navigation` runs the url navigator and its `target` is judged as a url target|
180
180
|**label**|`string`| optional | The item's text. A literal string, placed as-is — localize through the translation bundle entry for this component id |
181
181
|**icon**|`string`| optional | Lucide icon name drawn before the label, resolved through the shared action-icon resolver (an unknown name draws no icon) |
182
182
|**type**|`string`| optional | Executor the action runner dispatches to — built in: `script`, `url`, `modal`, `flow`, `api`, `form`; a handler registered under another name is dispatched too. `navigation`, the runner's alias of `url`, is refused: write `url`. A member is an action entry, so its executor is `type` (on an `action:button` node it is `actionType`) |
@@ -186,7 +186,7 @@ const result = ActionButtonPropsSchema.parse(data);
186
186
|**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 |
187
187
|**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 |
188
188
|**description**|`string`| optional | Action description, forwarded to the runner — the parameter dialog shows it under its title |
189
-
|**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 |
189
+
|**target**|`string`| optional | Executor target, forwarded to the runner: the URL, script name, flow name or API endpoint, per `type`. For the url navigator (`type: 'url'`, or no `type` and a `name` of `url` or `navigation`): 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 |
190
190
|**openIn**|`Enum<'self' \| 'new-tab'>`| optional | For a `url` action: `self` navigates in place, `new-tab` opens a new browser tab |
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 |
0 commit comments