Icon class
A standalone icon element. Icons can be picked from the vast Adaptive Card icon catalog.
Constructors
| Icon(string, Icon |
Properties
| color | The color of the icon. |
| fallback | An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property. |
| grid. |
The area of a Layout.AreaGrid layout in which an element should be displayed. |
| horizontal |
Controls how the element should be horizontally aligned. |
| id | A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. |
| is |
Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. |
| is |
Controls the visibility of the element. |
| lang | The locale associated with the element. |
| name | The name of the icon to display. |
| requires | A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided). |
| select |
An Action that will be invoked when the icon is tapped or clicked. Action.ShowCard is not supported. |
| separator | Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. |
| size | The size of the icon. |
| spacing | Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. |
| style | The style of the icon. |
| target |
Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout. |
| type | Must be Icon. |
Methods
Constructor Details
Icon(string, IconOptions)
Property Details
color
fallback
An alternate element to render if the type of this one is unsupported or if the host application doesn't support all the capabilities specified in the requires property.
fallback?: FallbackElementProperty Value
grid.area
The area of a Layout.AreaGrid layout in which an element should be displayed.
grid.area?: stringProperty Value
string
horizontalAlignment
Controls how the element should be horizontally aligned.
horizontalAlignment?: HorizontalAlignmentProperty Value
id
A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot.
id?: stringProperty Value
string
isSortKey
Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements.
isSortKey?: booleanProperty Value
boolean
isVisible
Controls the visibility of the element.
isVisible?: booleanProperty Value
boolean
lang
The locale associated with the element.
lang?: stringProperty Value
string
name
The name of the icon to display.
name: stringProperty Value
string
requires
A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided).
requires?: IHostCapabilitiesProperty Value
selectAction
An Action that will be invoked when the icon is tapped or clicked. Action.ShowCard is not supported.
selectAction?: IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityActionProperty Value
separator
Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true.
separator?: booleanProperty Value
boolean
size
spacing
Controls the amount of space between this element and the previous one. No space will be added for the first element in a container.
spacing?: SpacingProperty Value
style
targetWidth
Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see Responsive layout.
targetWidth?: TargetWidthProperty Value
type
Must be Icon.
type: "Icon" = "Icon"Property Value
"Icon"
Method Details
from(Omit<IIcon, "type">)
withColor(TextColor)
withFallback(FallbackElement)
withHorizontalAlignment(HorizontalAlignment)
function withHorizontalAlignment(horizontalAlignment: HorizontalAlignment): IconParameters
- horizontalAlignment
- HorizontalAlignment
Returns
withId(string)
withIsSortKey(boolean)
withIsVisible(boolean)
withLang(string)
withName(string)
withRequires(IHostCapabilities)
function withRequires(requires: IHostCapabilities): IconParameters
- requires
- IHostCapabilities
Returns
withSelectAction(IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityAction)
function withSelectAction(selectAction: IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityAction): IconParameters
- selectAction
-
IExecuteAction | IOpenUrlAction | IResetInputsAction | ISubmitAction | IToggleVisibilityAction