什麼是 HostConfig?

HostConfig 是跨平台的設定物件,可指定調適型卡片轉譯器產生 UI 的方式。

這可讓平台不可知的屬性,在不同平台和裝置上的轉譯器之間共用。 它也允許建立工具,讓您了解卡片針對指定環境會具備的外觀與風格。

請參閱 HostConfig.json \(英文\) 範例,以了解其內容。


卡片設定

AdaptiveCardConfig

適用於 AdaptiveCards 的 Toplevel 選項

屬性 類型 必要 描述 版本
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 的 Toplevel 選項 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" 控制 action 元素的整體間距 1.0
showCard object 否 控制 Action.ShowCard 的行為和樣式 1.0
iconPlacement string 否,預設值:"aboveTitle" 控制要放置動作圖示的位置 1.0
iconSize integer 否,預設值:30 控制動作圖示的大小 1.0

ContainerStylesConfig

控制預設容器和強調容器的樣式

屬性 類型 必要 描述 版本
預設值 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
預設值 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
預設值 integer 否,預設值:400   1.0
bolder integer 否,預設值:800   1.0

ForegroundColorsConfig

控制各種字型色彩

屬性 類型 必要 描述 版本
預設值 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
size string 否,預設值:"default" 要顯示之標籤的字型大小 1.3
尾碼 string 否,預設值:"*" 要針對必要輸入在標籤結尾顯示的尾碼。 如未定義任何項目,則會將星號 * 附加至標籤 1.3
weight string 否,預設值:"default" 標籤的字型加權 1.3

ErrorMessageConfig

控制錯誤訊息的顯示方式。 錯誤訊息一律會以 attention 色彩顯示。

屬性 類型 必要 描述 版本
spacing string 否,預設值:"default" 輸入與錯誤訊息之間的間距 1.3
size 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
預設值 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

控制文字顯示的參數

屬性 類型 必要 描述 版本
size 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