¿Qué es HostConfig?
HostConfig
es un objeto de configuración multiplataforma que especifica cómo un representador de Tarjeta adaptable genera una interfaz de usuario.
Esto permite compartir las propiedades que son independientes de la plataforma entre los representadores en diferentes plataformas y dispositivos. También permite crear las herramientas, lo que te da una idea de la apariencia y el funcionamiento de la tarjeta para un entorno determinado.
Ve un ejemplo de HostConfig.json para hacerte una idea de cómo es su contenido.
AdaptiveCardConfig
: opciones de nivel superior deAdaptiveCards
.ActionsConfig
: opciones deAction
.ContainerStylesConfig
: controla el estilo de los contenedores de énfasis y predeterminados.FactSetConfig
: controla la visualización deFactSet
.FontSizesConfig
: controla las métricas de tamaño de fuente de los distintos estilos de texto.FontWeightsConfig
: controla las métricas de espesor de la fuente.ForegroundColorsConfig
: controla los diferentes colores de fuente.ImageSetConfig
: controla cómo se muestraImageSet
.ImageSizesConfig
: controla los tamaños deImage
.InputsConfig
: controla cómo se muestran las etiquetas y los mensajes de error.LabelConfig
: controla cómo se muestran las etiquetas.InputLabelConfig
: controla cómo se muestran las etiquetas necesarias u opcionales.
ErrorMessageConfig
: controla cómo se muestran los mensajes de error.
MediaConfig
: controla la visualización y el comportamiento de los elementosMedia
.SeparatorConfig
: controla cómo se muestran los separadores.ShowCardConfig
: controla el comportamiento y el estilo deAction.ShowCard
.SpacingsConfig
: controla cómo se deben disponer los elementos.TextBlockConfig
: parámetros que controlan la visualización de texto.
Configuración de la tarjeta
AdaptiveCardConfig
Opciones de nivel superior de AdaptiveCards
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
allowCustomStyle | boolean |
No; valor predeterminado: true |
Controla si se permite el estilo personalizado. | 1.0 |
supportsInteractivity | boolean |
No; valor predeterminado:true |
Controla si se permite que se invoquen elementos Action interactivos. |
1.0 |
imageBaseUrl | string |
No | Dirección URL base que se va a usar al cargar recursos. | 1.0 |
fontFamily | string |
No; valor predeterminado: "Calibri" |
Fuente que se va a utilizar al representar texto. | 1.0 |
actions | object |
No | Opciones de Action |
1.0 |
adaptiveCard | object |
No | Opciones de nivel superior de AdaptiveCards . |
1.0 |
containerStyles | object |
No | Controla el estilo de los contenedores de énfasis y predeterminados. | 1.0 |
imageSizes | object |
No | Controla los tamaños de Image . |
1.0 |
imageSet | object |
No | Controla cómo se muestra ImageSet . |
1.0 |
factSet | object |
No | Controla la visualización de FactSet . |
1.0 |
fontSizes | object |
No | Controla las métricas de tamaño de fuente de los distintos estilos de texto. | 1.0 |
fontWeights | object |
No | Controla las métricas de espesor de la fuente. | 1.0 |
spacing | object |
No | Controla cómo se deben disponer los elementos. | 1.0 |
separator | object |
No | Controla cómo se muestran los separadores. | 1.0 |
media | object |
No | Controla la visualización y el comportamiento de los elementos Media . |
1.1 |
ActionsConfig
Opciones de Action
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
actionsOrientation | string |
No; valor predeterminado: "horizontal" |
Controla la disposición de los botones. | 1.0 |
actionAlignment | string |
No; valor predeterminado: "stretch" |
Controla el diseño de los botones. | 1.0 |
buttonSpacing | integer |
No; valor predeterminado: 10 |
Controla la cantidad de espacio que se va a usar entre los botones. | 1.0 |
maxActions | integer |
No; valor predeterminado: 5 |
Controla el número de acciones permitidas en total. | 1.0 |
spacing | string |
No; valor predeterminado: "default" |
Controla el espaciado total del elemento de acción. | 1.0 |
showCard | object |
No | Controla el comportamiento y el estilo de Action.ShowCard . |
1.0 |
iconPlacement | string |
No; valor predeterminado: "aboveTitle" |
Controla dónde colocar el icono de acción. | 1.0 |
iconSize | integer |
No; valor predeterminado: 30 |
Controla el tamaño del icono de acción. | 1.0 |
ContainerStylesConfig
Controla el estilo de los contenedores de énfasis y predeterminados.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
default | object |
No | Estilo de contenedor predeterminado. | 1.0 |
emphasis | object |
No | Estilo de contenedor que se va a usar para dar énfasis. | 1.0 |
FactSetConfig
Controla la visualización de FactSet
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
title | object |
No; valor predeterminado: {"weight":"bolder","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":150} |
Parámetros que controlan la visualización de texto. | 1.0 |
value | object |
No; valor predeterminado: {"weight":"default","size":"default","color":"default","isSubtle":false,"wrap":true,"maxWidth":0} |
Parámetros que controlan la visualización de texto. | 1.0 |
spacing | integer |
No; valor predeterminado: 10 |
1.0 |
FontSizesConfig
Controla las métricas de tamaño de fuente de los distintos estilos de texto.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
small | integer |
No; valor predeterminado: 10 |
Tamaño de fuente del texto. | 1.0 |
default | integer |
No; valor predeterminado: 12 |
Tamaño de fuente predeterminado | 1.0 |
medium | integer |
No; valor predeterminado: 14 |
Tamaño de fuente medio. | 1.0 |
large | integer |
No; valor predeterminado: 17 |
Tamaño de fuente grande. | 1.0 |
extraLarge | integer |
No; valor predeterminado: 20 |
Tamaño de fuente muy grande. | 1.0 |
FontWeightsConfig
Controla las métricas de espesor de la fuente.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
lighter | integer |
No; valor predeterminado: 200 |
1.0 | |
default | integer |
No; valor predeterminado:400 |
1.0 | |
bolder | integer |
No; valor predeterminado: 800 |
1.0 |
ForegroundColorsConfig
Controla los diferentes colores de fuente.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
default | object |
No; valor predeterminado: {"default":"#FF000000","subtle":"#B2000000"} |
1.0 | |
accent | object |
No; valor predeterminado:{"default":"#FF0000FF","subtle":"#B20000FF"} |
1.0 | |
dark | object |
No; valor predeterminado: {"default":"#FF101010","subtle":"#B2101010"} |
1.0 | |
light | object |
No; valor predeterminado:{"default":"#FFFFFFFF","subtle":"#B2FFFFFF"} |
1.0 | |
good | object |
No; valor predeterminado: {"default":"#FF008000","subtle":"#B2008000"} |
1.0 | |
warning | object |
No; valor predeterminado:{"default":"#FFFFD700","subtle":"#B2FFD700"} |
1.0 | |
attention | object |
No; valor predeterminado: {"default":"#FF8B0000","subtle":"#B28B0000"} |
1.0 |
ImageSetConfig
Controla cómo se muestra ImageSet
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
imageSize | string |
No; valor predeterminado: "auto" |
Controla el tamaño de una imagen individual. | 1.0 |
maxImageHeight | integer |
No; valor predeterminado:100 |
Restringe la altura de la imagen a este valor. | 1.0 |
ImageSizesConfig
Controla los tamaños de Image
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
small | integer |
No; valor predeterminado: 80 |
Valor de tamaño de imagen pequeño. | 1.0 |
medium | integer |
No; valor predeterminado: 120 |
Valor de tamaño de imagen medio. | 1.0 |
large | integer |
No; valor predeterminado:180 |
Valor de tamaño de imagen grande. | 1.0 |
InputsConfig
Controla cómo se muestran las etiquetas y los mensajes de error.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
label | LabelConfig |
No | Controla cómo se muestran las etiquetas. | 1.3 |
errorMessage | ErrorMessageConfig |
No | Controla cómo se muestran los mensajes de error. | 1.3 |
LabelConfig
Controla cómo se muestran las etiquetas.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
requiredInputs | InputLabelConfig |
No | Controla cómo se muestran las etiquetas para las entradas obligatorias. | 1.3 |
optionalInputs | InputLabelConfig |
No | Controla cómo se muestran las etiquetas para las entradas opcionales. | 1.3 |
spacing | string |
No; valor predeterminado: "default" |
Espaciado entre la etiqueta y la entrada | 1.3 |
InputLabelConfig
Controla cómo se muestran las etiquetas obligatorias u opcionales.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
color | string |
No; valor predeterminado:"default" |
Color de la fuente de la etiqueta (el sufijo siempre se representa en color attention ). |
1.3 |
isSubtle | bool |
No; valor predeterminado: false |
Define si se debe usar el color de primer plano subtle . |
1.3 |
size | string |
No; valor predeterminado: "default" |
Tamaño de la fuente de la etiqueta que se mostrará | 1.3 |
suffix | string |
No; valor predeterminado: "*" |
Sufijo que se mostrará al final de la etiqueta para las entradas obligatorias. Si no se define ninguno, se anexa un asterisco * a la etiqueta. |
1.3 |
weight | string |
No; valor predeterminado: "default" |
Peso de la fuente de la etiqueta | 1.3 |
ErrorMessageConfig
Controla cómo se muestran los mensajes de error. Los mensajes de error siempre se muestran con el color attention
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
spacing | string |
No; valor predeterminado: "default" |
Espaciado entre la entrada y el mensaje de error | 1.3 |
size | string |
No; valor predeterminado:"default" |
Tamaño de la fuente del mensaje de error | 1.3 |
weight | string |
No; valor predeterminado: "default" |
Peso de la fuente del mensaje de error | 1.3 |
MediaConfig
Controla la visualización y el comportamiento de los elementos Media
.
Introducido en versión 1.1.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
defaultPoster | string |
No | URI de la imagen que se va a mostrar cuando no se haya invocado el botón de reproducción. | 1.1 |
playButton | string |
No | Imagen que se va a mostrar como botón de reproducción. | 1.1 |
allowInlinePlayback | boolean |
No; valor predeterminado: true |
Indica si se van a mostrar elementos multimedia en línea o si se invocan externamente. | 1.1 |
SeparatorConfig
Controla cómo se muestran los separadores.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
lineThickness | integer |
No; valor predeterminado: 1 |
Grosor de la línea de separación. | 1.0 |
lineColor | string,null |
No; valor predeterminado: #B2000000 |
Color que se va a usar al dibujar la línea de separación. | 1.0 |
ShowCardConfig
Controla el comportamiento y el estilo de Action.ShowCard
.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
actionMode | string |
No; valor predeterminado: "inline" |
Controla cómo se muestra la tarjeta. | 1.0 |
style | object |
No; valor predeterminado: emphasis |
Controla el estilo de un contenedor. | 1.0 |
inlineTopMargin | integer |
No; valor predeterminado: 16 |
Cantidad de margen que se va a usar al mostrar la tarjeta. | 1.0 |
SpacingsConfig
Controla cómo se deben disponer los elementos.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
small | integer |
No; valor predeterminado:3 |
Valor de espaciado pequeño. | 1.0 |
default | integer |
No; valor predeterminado: 8 |
Valor de espaciado predeterminado. | 1.0 |
medium | integer |
No; valor predeterminado:20 |
Valor de espaciado medio. | 1.0 |
large | integer |
No; valor predeterminado: 30 |
Valor de espaciado grande. | 1.0 |
extraLarge | integer |
No; valor predeterminado: 40 |
Valor de espaciado muy grande. | 1.0 |
padding | integer |
No; valor predeterminado: 20 |
Valor de relleno. | 1.0 |
TextBlockConfig
Parámetros que controlan la visualización de texto.
Propiedad | Tipo | Obligatorio | Descripción | Versión |
---|---|---|---|---|
size | string |
No; valor predeterminado:"default" |
Tamaño de fuente que se utilizará cuando una tarjeta no lo especifica. | 1.0 |
weight | string |
No; valor predeterminado:"normal" |
Grosor de la fuente que se utilizará cuando una tarjeta no lo especifica. | 1.0 |
color | string |
No; valor predeterminado:"default" |
Color de fuente que se utilizará cuando una tarjeta no lo especifica. | 1.0 |
isSubtle | boolean |
No; valor predeterminado: false |
El texto debe ser tenue si una tarjeta no lo especifica. | 1.0 |
wrap | boolean |
No; valor predeterminado:true |
Debe utilizarse ajuste de texto si una tarjeta no lo especifica. | 1.0 |
maxWidth | integer |
No; valor predeterminado: 0 |
Ancho máximo que se usará si una tarjeta no lo especifica. | 1.0 |