Suggestions de saisie semi-automatique pour le texte

Le widget Saisie de texte permet à votre module complémentaire de lire le texte fourni par les utilisateurs et d'y réagir. Vous pouvez configurer ces widgets pour fournir aux utilisateurs des suggestions automatiques pour le texte saisi.

Les suggestions fournies peuvent provenir d'une liste statique de chaînes que vous fournissez. Vous pouvez également créer des suggestions à partir du contexte, comme le texte que l'utilisateur a déjà saisi dans le widget.

Configurer les suggestions

Pour configurer des suggestions pour une saisie de texte, il vous suffit de procéder comme suit :

  • Créez une liste de suggestions en :
    • créer une liste statique ;
    • Définissez une action avec une fonction de rappel qui crée cette liste de manière dynamique à partir du contexte.
  • Associez la liste de suggestions et/ou l'action au widget de saisie de texte.

Si vous fournissez à la fois une liste statique de suggestions et une action, l'UI de l'application utilise la liste statique jusqu'à ce que l'utilisateur commence à saisir des caractères. La fonction de rappel est alors utilisée et la liste statique est ignorée.

Suggestions statiques

Pour proposer une liste statique de suggestions, il vous suffit de procéder comme suit :

  1. Créez un objet Suggestions.
  2. Ajoutez chaque suggestion statique à l'aide de addSuggestion() ou addSuggestions().
  3. Associez l'objet Suggestions au widget à l'aide de TextInput.setSuggestions().

L'UI affiche les suggestions statiques dans l'ordre dans lequel elles ont été ajoutées. L'UI effectue également automatiquement une correspondance de préfixe insensible à la casse et filtre la liste de suggestions à mesure que l'utilisateur saisit des caractères dans le widget.

Actions de suggestion

Si vous n'utilisez pas de liste de suggestions statique, vous devez définir une action pour générer vos suggestions de manière dynamique. Pour ce faire, procédez comme suit :

  1. Créez un objet Action et associez-le à une fonction de rappel que vous définissez.
  2. Appelez la fonction TextInput.setSuggestionsAction() du widget en lui fournissant l'objet Action.
  3. Implémentez la fonction de rappel pour créer la liste de suggestions et renvoyer un objet SuggestionsResponse créé.

L'UI appelle la fonction de rappel chaque fois que l'utilisateur saisit un caractère dans le champ de texte, mais uniquement après que l'utilisateur a cessé de taper pendant un moment. La fonction de rappel reçoit un objet d'événement contenant des informations sur les widgets de la carte ouverte. Pour en savoir plus, consultez Objets d'événement d'action.

La fonction de rappel doit renvoyer un objet SuggestionsResponse valide contenant la liste des suggestions à afficher. L'UI affiche les suggestions dans l'ordre dans lequel elles sont ajoutées. Contrairement aux listes statiques, l'UI ne filtre pas automatiquement les suggestions de rappel en fonction de la saisie de l'utilisateur. Si vous souhaitez appliquer un tel filtrage, vous devez lire la valeur de l'entrée de texte à partir de l'objet d'événement et filtrer vos suggestions à mesure que vous construisez la liste.

Exemple

L'extrait de code de module complémentaire Google Workspace suivant montre comment configurer des suggestions sur deux widgets de saisie de texte différents, le premier avec une liste statique et le second à l'aide d'une fonction de rappel :

// Create an input with a static suggestion list.
var textInput1 = CardService.newTextInput()
    .setFieldName('colorInput')
    .setTitle('Color choice')
    .setSuggestions(CardService.newSuggestions()
        .addSuggestion('Red')
        .addSuggestion('Yellow')
        .addSuggestions(['Blue', 'Black', 'Green']));

// Create an input with a dynamic suggestion list.
var action = CardService.newAction()
    .setFunctionName('refreshSuggestions');
var textInput2 = CardService.newTextInput()
    .setFieldName('emailInput')
    .setTitle('Email')
    .setSuggestionsAction(action);

// ...

/**
 *  Build and return a suggestion response. In this case, the suggestions
 *  are a list of emails taken from the To: and CC: lists of the open
 *  message in Gmail, filtered by the text that the user has already
 *  entered. This method assumes the Google Workspace
 *  add-on extends Gmail; the add-on only calls this method for cards
 *  displayed when the user has entered a message context.
 *
 *  @param {Object} e the event object containing data associated with
 *      this text input widget.
 *  @return {SuggestionsResponse}
 */
 function refreshSuggestions(e) {
   // Activate temporary Gmail scopes, in this case so that the
   // open message metadata can be read.
   var accessToken = e.gmail.accessToken;
   GmailApp.setCurrentMessageAccessToken(accessToken);

   var userInput = e && e.formInput['emailInput'].toLowerCase();
   var messageId = e.gmail.messageId;
   var message = GmailApp.getMessageById(messageId);

   // Combine the comma-separated returned by these methods.
   var addresses = message.getTo() + ',' + message.getCc();

   // Filter the address list to those containing the text the user
   // has already entered.
   var suggestionList = [];
   addresses.split(',').forEach(function(email) {
     if (email.toLowerCase().indexOf(userInput) !== -1) {
       suggestionList.push(email);
     }
   });
   suggestionList.sort();

   return CardService.newSuggestionsResponseBuilder()
       .setSuggestions(CardService.newSuggestions()
           .addSuggestions(suggestionList))
       .build();  // Don't forget to build the response!
 }

Suggestions et OnChangeAction()

Les widgets de saisie de texte peuvent avoir une fonction de gestionnaire setOnChangeAction() définie qui s'exécute chaque fois que le widget perd le focus. Si ce gestionnaire et les suggestions sont tous deux activés pour la même entrée de texte, les règles suivantes définissent le comportement d'interaction de l'entrée de texte :

  1. Le gestionnaire setOnChangeAction() s'exécute après la sélection d'une suggestion.
  2. Si l'utilisateur appuie sur Entrée (ou fait perdre le focus à la saisie de texte d'une autre manière) sans modifier la suggestion sélectionnée, setOnChangeAction() ne se déclenche pas à nouveau.
  3. setOnChangeAction() se déclenche à nouveau si l'utilisateur, après avoir sélectionné une suggestion, la modifie de sorte qu'elle ne corresponde plus à aucune des suggestions de la liste.
  4. Si l'utilisateur ne sélectionne aucune suggestion, setOnChangeAction() se déclenche lorsque le champ de saisie de texte perd le focus.