什么是 HostConfig?

HostConfig 是一个跨平台配置对象,用于指定自适应卡片呈现器生成 UI 的方式。

这样,那些跨平台的属性就可以在不同平台和设备的呈现器中共享。 另外还可以创建工具,让你了解该卡片在给定环境下的外观。

请查看 HostConfig.json 示例,了解其内容。


卡片配置

AdaptiveCardConfig

AdaptiveCards 的顶级选项

属性 类型 必需 说明 版本
allowCustomStyle boolean 否,默认值为:true 控制是否允许自定义样式设置 1.0
supportsInteractivity boolean 否,默认值为:true 控制是否允许调用交互式 Action 1.0
imageBaseUrl string 在加载资源时需要使用的 URL 1.0
fontFamily string 否,默认值为:"Calibri" 呈现文本时需要使用的字体 1.0
actions object Action 的选项 1.0
adaptiveCard object AdaptiveCards 的顶级选项 1.0
containerStyles object 控制默认的强调容器的样式设置 1.0
imageSizes object 控制 Image 大小 1.0
imageSet object 控制 ImageSet 的显示方式 1.0
factSet object 控制 FactSet 的显示 1.0
fontSizes object 控制不同文本样式的字体大小指标 1.0
fontWeights object 控制字体粗细指标 1.0
spacing object 控制元素的布局方式 1.0
separator object 控制分隔符的显示方式 1.0
media object 控制 Media 元素的显示和行为 1.1

ActionsConfig

Action 的选项

属性 类型 必需 说明 版本
actionsOrientation string 否,默认值为:"horizontal" 控制按钮的布局方式 1.0
actionAlignment string 否,默认值为:"stretch" 控制按钮的布局 1.0
buttonSpacing integer 否,默认值为:10 控制在按钮之间使用的空间量 1.0
maxActions integer 否,默认值为:5 控制允许的操作总数 1.0
spacing string 否,默认值为:"default" 控制操作元素的总体间距 1.0
showCard object 控制 Action.ShowCard 的行为和样式设置 1.0
iconPlacement string 否,默认值为:"aboveTitle" 控制操作图标的放置位置 1.0
iconSize integer 否,默认值为:30 控制操作图标的大小 1.0

ContainerStylesConfig

控制默认的强调容器的样式设置

属性 类型 必需 说明 版本
default object 默认的容器样式 1.0
emphasis object 用于强调的容器样式 1.0

FactSetConfig

控制 FactSet 的显示

属性 类型 必需 说明 版本
title object 否,默认值为:{"weight":"bolder","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":150} 控制文本显示的参数 1.0
value object 否,默认值为:{"weight":"default","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":0} 控制文本显示的参数 1.0
spacing integer 否,默认值为:10   1.0

FontSizesConfig

控制不同文本样式的字体大小指标

属性 类型 必需 说明 版本
small integer 否,默认值为:10 小字号 1.0
default integer 否,默认值为:12 默认字号 1.0
medium integer 否,默认值为:14 中字号 1.0
large integer 否,默认值为:17 大字号 1.0
extraLarge integer 否,默认值为:20 超大字号 1.0

FontWeightsConfig

控制字体粗细指标

属性 类型 必需 说明 版本
lighter integer 否,默认值为:200   1.0
default integer 否,默认值为:400   1.0
bolder integer 否,默认值为:800   1.0

ForegroundColorsConfig

控制各种字体颜色

属性 类型 必需 说明 版本
default object 否,默认值为:{"default":"#FF000000","subtle":"#B2000000"}   1.0
accent object 否,默认值为:{"default":"#FF0000FF","subtle":"#B20000FF"}   1.0
dark object 否,默认值为:{"default":"#FF101010","subtle":"#B2101010"}   1.0
light object 否,默认值为:{"default":"#FFFFFFFF","subtle":"#B2FFFFFF"}   1.0
good object 否,默认值为:{"default":"#FF008000","subtle":"#B2008000"}   1.0
warning object 否,默认值为:{"default":"#FFFFD700","subtle":"#B2FFD700"}   1.0
attention object 否,默认值为:{"default":"#FF8B0000","subtle":"#B28B0000"}   1.0

ImageSetConfig

控制 ImageSet 的显示方式

属性 类型 必需 说明 版本
imageSize string 否,默认值为:"auto" 控制单个图像大小 1.0
maxImageHeight integer 否,默认值为:100 将图像高度限制为此值 1.0

ImageSizesConfig

控制 Image 大小

属性 类型 必需 说明 版本
small integer 否,默认值为:80 小型图像大小值 1.0
medium integer 否,默认值为:120 中型图像大小值 1.0
large integer 否,默认值为:180 大型图像大小值 1.0

InputsConfig

控制标签和错误消息的显示方式

属性 类型 必需 说明 版本
label LabelConfig 控制标签的显示方式 1.3
errorMessage ErrorMessageConfig 控制错误消息的显示方式 1.3

LabelConfig

控制标签的显示方式

属性 类型 必需 说明 版本
requiredInputs InputLabelConfig 控制必需输入项的标签的显示方式 1.3
optionalInputs InputLabelConfig 控制可选输入项的标签的显示方式 1.3
spacing string 否,默认值为:"default" 标签与输入项之间的间距 1.3

InputLabelConfig

控制必需标签或可选标签的显示方式

属性 类型 必需 说明 版本
color string 否,默认值为:"default" 标签的字体颜色(后缀始终以 attention 颜色呈现) 1.3
isSubtle bool 否,默认值为:false 定义是否使用 subtle 前景色 1.3
大小 string 否,默认值为:"default" 要显示的标签的字体大小size 1.3
suffix string 否,默认值为:"*" 要在必需输入项的标签末尾显示的后缀。 如果未定义任何后缀,则向标签追加星号 * 1.3
weight string 否,默认值为:"default" 标签的字体粗细 1.3

ErrorMessageConfig

控制错误消息的显示方式。 错误消息始终以 attention 颜色显示。

属性 类型 必需 说明 版本
spacing string 否,默认值为:"default" 输入项与错误消息之间的间距 1.3
大小 string 否,默认值为:"default" 错误消息的字体大小 1.3
weight string 否,默认值为:"default" 错误消息的字体粗细 1.3

MediaConfig

控制 Media 元素的显示和行为

在版本 1.1 中引入

属性 类型 必需 说明 版本
defaultPoster string 在播放按钮尚未调用时需显示的图像的 URI 1.1
playButton string 将显示为播放按钮的图像 1.1
allowInlinePlayback boolean 否,默认值为:true 是以内联方式显示媒体,还是通过外部方式进行调用 1.1

SeparatorConfig

控制分隔符的显示方式

属性 类型 必需 说明 版本
lineThickness integer 否,默认值为:1 分隔线的粗细 1.0
lineColor string,null 否,默认值为:#B2000000 绘制分隔线时需使用的颜色 1.0

ShowCardConfig

控制 Action.ShowCard 的行为和样式设置

属性 类型 必需 说明 版本
actionMode string 否,默认值为:"inline" 控制卡的显示方式 1.0
style object 否,默认值为:emphasis 控制容器的样式设置 1.0
inlineTopMargin integer 否,默认值为:16 显示卡片时需使用的边距 1.0

SpacingsConfig

控制元素的布局方式

属性 类型 必需 说明 版本
small integer 否,默认值为:3 小间距值 1.0
default integer 否,默认值为:8 默认间距值 1.0
medium integer 否,默认值为:20 中间距值 1.0
large integer 否,默认值为:30 大间距值 1.0
extraLarge integer 否,默认值为:40 超大间距值 1.0
padding integer 否,默认值为:20 填充值 1.0

TextBlockConfig

控制文本显示的参数

属性 类型 必需 说明 版本
大小 string 否,默认值为:"default" 卡片未指定时需使用的字号 1.0
weight string 否,默认值为:"normal" 卡片未指定时需使用的字体粗细 1.0
color string 否,默认值为:"default" 卡片未指定时需使用的字体颜色 1.0
isSubtle boolean 否,默认值为:false 卡片未指定时文本是否为细微 1.0
wrap boolean 否,默认值为:true 卡片未指定时文本是否换行 1.0
maxWidth integer 否,默认值为:0 卡片未指定时要使用的最大宽度 1.0