3.3 KiB
3.3 KiB
Action.OpenUrl
Property | Type | Required | Description | Version |
---|---|---|---|---|
type | "Action.OpenUrl" |
Yes | Must be "Action.OpenUrl" . |
1.0 |
url | uri |
Yes | The URL to open. | 1.0 |
Inherited properties
Property | Type | Required | Description | Version |
---|---|---|---|---|
title | string |
No | Label for button or link that represents this action. | 1.0 |
iconUrl | uri |
No | Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+ | 1.1 |
id | string |
No | A unique identifier associated with this Action. | 1.0 |
style | ActionStyle |
No | Controls the style of an Action, which influences how the action is displayed, spoken, etc. | 1.2 |
fallback | Action , FallbackOption |
No | Describes what to do when an unknown element is encountered or the requires of this or any children can't be met. | 1.2 |
tooltip | string |
No | Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software. | 1.5 |
isEnabled | boolean |
No, default: true |
Determines whether the action should be enabled. | 1.5 |
mode | ActionMode |
No, default: "primary" |
Determines whether the action should be displayed as a button or in the overflow menu. | 1.5 |
requires | Dictionary<string> |
No | A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered. | 1.2 |
style
Controls the style of an Action, which influences how the action is displayed, spoken, etc.
- Type:
ActionStyle
- Version : 1.2
- Required: No
- Allowed values:
"default"
: Action is displayed as normal"positive"
: Action is displayed with a positive style (typically the button becomes accent color)"destructive"
: Action is displayed with a destructive style (typically the button becomes red)
fallback
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
- Type:
Action
,FallbackOption
- Version : 1.2
- Required: No
- Allowed values:
Action.Execute
Action.OpenUrl
Action.ShowCard
Action.Submit
Action.ToggleVisibility
"drop"
: Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.
mode
Determines whether the action should be displayed as a button or in the overflow menu.
- Type:
ActionMode
- Version : 1.5
- Required: No, default:
"primary"
- Allowed values:
"primary"
: Action is displayed as a button."secondary"
: Action is placed in an overflow menu (typically a popup menu under a...
button).
Rendering
See ActionSet
.
When user invokes this action, invoke the ActionInvoked
event, passing along this action, so that host can take the appropriate action.