Input.Text

Note

Créez-vous des scénarios Copilot, Teams ou Outlook optimisés par des cartes adaptatives ? Visitez le Hub de documentation sur la carte adaptative, le nouveau magasin unique pour tous vos besoins en carte adaptative ! Il dispose de toutes les ressources que vous recherchez, y compris la documentation complète pour de nombreuses nouvelles fonctionnalités, telles que la disposition réactive, l’icône, le badge, le carrouel, les graphiques, etc.

Remarque importante sur l’accessibilité : Dans la version 1.3 du schéma, nous avons introduit une propriété d’étiquette sur les entrées pour améliorer l’accessibilité. Si l’application hôte que vous ciblez prend en charge la version 1.3, vous devez utiliser l’étiquette au lieu d’un TextBlock comme indiqué dans certains exemples ci-dessous. Une fois que la plupart des applications hôtes ont été mises à jour vers la dernière version, nous allons mettre à jour les exemples en conséquence.

Input.Text

Permet à un utilisateur d’entrer du texte.

Propriétés Input.Text

Propriété Type Obligatoire Descriptif Version
type "Input.Text" Oui Doit être "Input.Text". 1,0
id string Oui Identificateur unique de la valeur. Permet d’identifier les entrées collectées lorsque l’action Envoyer est effectuée. 1,0
isMultiline boolean Non Si true, autorisez plusieurs lignes d’entrée. 1,0
maxLength number Non Indice de longueur maximale de caractères à collecter (peut être ignoré par certains clients). 1,0
Espace réservé string Non Description de l’entrée souhaitée. Affiché lorsqu’aucun texte n’a été entré. 1,0
regex string Non Expression régulière indiquant le format requis de cette entrée de texte. 1.3
style TextInputStyle Non Indicateur de style pour l’entrée de texte. 1,0
inlineAction ISelectAction Non Action inline pour l’entrée. Généralement affiché à droite de l’entrée. Il est vivement recommandé de fournir une icône sur l’action (qui sera affichée au lieu du titre de l’action). 1.2
value string Non Valeur initiale de ce champ. 1,0

Propriétés héritées

Propriété Type Obligatoire Descriptif Version
Errormessage string Non Message d’erreur à afficher lorsque l’entrée entrée n’est pas valide 1.3
isRequired boolean Non Indique si cette entrée est requise ou non 1.3
label string Non Étiquette pour cette entrée 1.3
labelPosition InputLabelPosition Non [PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Détermine la position de l’étiquette. Il peut prendre des valeurs « inline » et « ci-dessus ». Par défaut, l’étiquette est placée « au-dessus » lorsque la position de l’étiquette n’est pas spécifiée. 1.6
labelWidth string, number Non [PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Détermine la largeur de l’étiquette en pourcentage comme 40 ou une largeur de pixel spécifique comme « 40px » lorsque l’étiquette est placée en ligne avec l’entrée. labelWidth est ignoré lorsque l’étiquette est affichée au-dessus de l’entrée. 1.6
inputStyle InputStyle Non [PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Indicateur de style pour les champs d’entrée. Permet aux champs d’entrée d’apparaître en lecture seule, mais lorsque l’utilisateur clique/se concentre sur le champ, il leur permet de mettre à jour ces champs. 1.6
Solution de repli Element, FallbackOption Non Décrit ce qu’il faut faire lorsqu’un élément inconnu est rencontré ou si les besoins de ce ou de tous les enfants ne peuvent pas être rencontrés. 1.2
height BlockElementHeight Non Spécifie la hauteur de l’élément. 1.1
separator boolean Non Quand true, dessinez une ligne de séparation en haut de l’élément. 1,0
espacement Spacing Non Contrôle la quantité d’espacement entre cet élément et l’élément précédent. 1,0
isVisible boolean Non, valeur par défaut : true Si false, cet élément sera supprimé de l’arborescence visuelle. 1.2
Exige Dictionary<string> Non Série de paires clé/valeur indiquant les fonctionnalités requises par l’élément avec la version minimale correspondante. Lorsque qu’une fonctionnalité est manquante ou n'est pas à la version requise, un mécanisme de secours est déclenché. 1.2

Example

Exemple 1 : Entrées de texte par défaut, multiligne et préremplies

JSON Carte adaptative
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.0", "body": [ { "type": "TextBlock", "text": "Default text input" }, { "type": "Input.Text", "id": "defaultInputId", "placeholder": "enter comment", "maxLength": 500 }, { "type": "TextBlock", "text": "Multiline text input" }, { "type": "Input.Text", "id": "multilineInputId", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true }, { "type": "TextBlock", "text": "Pre-filled value" }, { "type": "Input.Text", "id": "prefilledInputId", "placeholder": "enter comment", "maxLength": 500, "isMultiline": true, "value": "This value was pre-filled" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] } [Carte Adaptive Essayez par vous-même >]

Propriétés

isMultiline (version 1.0)

Si true, autorisez plusieurs lignes d’entrée.

  • Type : boolean
  • Obligatoire : Non

maxLength (version 1.0)

Suggestion de longueur maximale de caractères à collecter (peut être ignorée par certains clients).

  • Type : number
  • Obligatoire : Non

espace réservé (version 1.0)

Description de l’entrée souhaitée. Affiché lorsqu’aucun texte n’a été entré.

  • Type : string
  • Obligatoire : Non

regex (version 1.3)

Expression régulière indiquant le format requis de cette entrée de texte.

  • Type : string
  • Version : 1.3
  • Obligatoire : Non

style (version 1.0)

Indicateur de style pour l’entrée de texte.

  • Type : TextInputStyle
  • Obligatoire : Non
  • Valeurs autorisées :
    • "text"
    • "tel"
    • "url"
    • "email"
    • "password": ajouté dans la version 1.5. Afficher le texte d’entrée avec masquage de mot de passe.
JSON Carte adaptative
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.3", "body": [ { "type": "TextBlock", "text": "Specify the type of text being requested:", "style": "heading" }, { "type": "Input.Text", "id": "myComment", "label": "style: text", "style": "text" }, { "type": "Input.Text", "id": "myEmail", "label": "style: email", "style": "email" }, { "type": "Input.Text", "id": "myTel", "label": "style: tel", "style": "tel" }, { "type": "Input.Text", "id": "myUrl", "label": "style: url", "style": "url" }, { "type": "Input.Text", "id": "myPassword", "label": "style: password", "style": "password" } ], "actions": [ { "type": "Action.Submit", "title": "OK" } ] } [Carte Adaptive Essayez par vous-même >]

inlineAction (version 1.2)

Action inline pour l’entrée. Généralement affiché à droite de l’entrée. Il est vivement recommandé de fournir une icône sur l’action (qui sera affichée au lieu du titre de l’action).

  • Type : ISelectAction
  • Version : 1.2
  • Obligatoire : Non
  • Valeurs autorisées :
    • Action.Execute
    • Action.OpenUrl
    • Action.Submit
    • Action.ToggleVisibility
JSON Carte adaptative
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.5", "body": [ { "type": "Input.Text", "id": "iconInlineActionId", "label": "Text input with an inline action", "inlineAction": { "type": "Action.Submit", "iconUrl": "https://adaptivecards.io/content/send.png", "tooltip": "Send" } }, { "type": "Input.Text", "label": "Text input with an inline action with no icon", "id": "textInlineActionId", "inlineAction": { "type": "Action.OpenUrl", "title": "Reply", "tooltip": "Reply to this message", "url": "https://adaptivecards.io" } } ] } [Carte Adaptive Essayez par vous-même >]

valeur (version 1.0)

Valeur initiale de ce champ.

  • Type : string
  • Obligatoire : Non

id (version 1.0)

Identificateur unique de la valeur. Permet d’identifier les entrées collectées lorsque l’action Envoyer est effectuée.

  • Type : string
  • Obligatoire : Oui

errorMessage (version 1.3)

Message d’erreur à afficher lorsque l’entrée entrée n’est pas valide

  • Type : string
  • Version : 1.3
  • Obligatoire : Non

isRequired (version 1.3)

Indique si cette entrée est requise ou non

  • Type : boolean
  • Version : 1.3
  • Obligatoire : Non

étiquette (version 1.3)

Étiquette pour cette entrée

  • Type : string
  • Version : 1.3
  • Obligatoire : Non

labelPosition (version 1.6)

[PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Détermine la position de l’étiquette. Il peut prendre des valeurs « inline » et « ci-dessus ». Par défaut, l’étiquette est placée « au-dessus » lorsque la position de l’étiquette n’est pas spécifiée.

  • Type : InputLabelPosition
  • Version : 1.6
  • Obligatoire : Non
  • Valeurs autorisées :
    • "inline"
    • "above"

labelWidth (version 1.6)

[PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Détermine la largeur de l’étiquette en pourcentage comme 40 ou une largeur de pixel spécifique comme « 40px » lorsque l’étiquette est placée en ligne avec l’entrée. labelWidth est ignoré lorsque l’étiquette est affichée au-dessus de l’entrée.

  • Type : string, number
  • Version : 1.6
  • Obligatoire : Non

inputStyle (version 1.6)

[PRIS EN CHARGE UNIQUEMENT DANS LE KIT SDK JAVASCRIPT] Indicateur de style pour les champs d’entrée. Permet aux champs d’entrée d’apparaître en lecture seule, mais lorsque l’utilisateur clique/se concentre sur le champ, il leur permet de mettre à jour ces champs.

  • Type : InputStyle
  • Version : 1.6
  • Obligatoire : Non
  • Valeurs autorisées :
    • "revealOnHover"
    • "default"

secours (version 1.2)

Décrit ce qu’il faut faire lorsqu’un élément inconnu est rencontré ou si les besoins de ce ou de tous les enfants ne peuvent pas être rencontrés.

  • Type : Element, FallbackOption
  • Version : 1.2
  • Obligatoire : Non
  • Valeurs autorisées :
    • ActionSet
    • ColumnSet
    • Container
    • FactSet
    • Image
    • ImageSet
    • Input.ChoiceSet
    • Input.Date
    • Input.Number
    • Input.Text
    • Input.Time
    • Input.Toggle
    • Media
    • RichTextBlock
    • Table
    • TextBlock
    • "drop": provoque la suppression immédiate de cet élément lorsque des éléments inconnus sont rencontrés. L'élément inconnu ne se propage pas plus haut.

hauteur (version 1.1)

Spécifie la hauteur de l’élément.

  • Type : BlockElementHeight
  • Version : 1.1
  • Obligatoire : Non
  • Valeurs autorisées :
    • "auto": la hauteur du conteneur sera déterminée par la hauteur de son contenu.
    • "stretch": le conteneur étire sa hauteur jusqu’à la hauteur restante disponible du conteneur parent.

séparateur (version 1.0)

Quand true, dessinez une ligne de séparation en haut de l’élément.

  • Type : boolean
  • Obligatoire : Non

espacement (version 1.0)

Contrôle la quantité d’espacement entre cet élément et l’élément précédent.

  • Type : Spacing
  • Obligatoire : Non
  • Valeurs autorisées :
    • "default"
    • "none"
    • "small"
    • "medium"
    • "large"
    • "extraLarge"
    • "padding"

isVisible (version 1.2)

Si false, cet élément sera supprimé de l’arborescence visuelle.

  • Type : boolean
  • Version : 1.2
  • Obligatoire : Non, valeur par défaut : true

nécessite (version 1.2)

Série de paires clé/valeur indiquant les fonctionnalités requises par l’élément avec la version minimale correspondante. Lorsque qu’une fonctionnalité est manquante ou n'est pas à la version requise, un mécanisme de secours est déclenché.

  • Type : Dictionary<string>
  • Version : 1.2
  • Obligatoire : Non