TextInput

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

El widget de TextInput proporciona un campo en el que los usuarios pueden ingresar texto. El widget admite sugerencias, que ayudan a los usuarios a ingresar datos uniformes, y acciones durante el cambio, que son Actions y se ejecutan cuando se produce un cambio en el campo de entrada de texto, como cuando un usuario agrega o borra texto.

Cuando necesites recopilar datos abstractos o desconocidos de los usuarios, usa este widget TextInput. Para recopilar datos definidos de los usuarios, usa el widget SelectionInput en su lugar.

Las apps de chat reciben y pueden procesar el valor del texto ingresado durante los eventos de entrada del formulario. Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

Solo se admite en diálogos. Pronto se admitirán los mensajes de tarjetas.

Ejemplo

En la siguiente imagen, se muestra una tarjeta que consta de un widget TextInput.

Un cuadro de diálogo con una variedad de widgets diferentes.
Figura 1: Diálogo que ayuda a un usuario a crear un contacto nuevo para su libreta de direcciones. Los campos de nombre y dirección son widgets de TextInput.

Este es el JSON de la tarjeta:

JSON

{
  "cardsV2": [
    {
      "cardId": "exampleCard",
      "card": {
        "sections": [
          {
            "header": "Add new contact",
            "widgets": [
              {
                "textInput": {
                  "label": "Name",
                  "type": "SINGLE_LINE",
                  "name": "contactName"
                }
              },
              {
                "textInput": {
                  "label": "Address",
                  "type": "MULTIPLE_LINE",
                  "name": "address"
                }
              },
              {
                "decoratedText": {
                  "text": "Add to favorites",
                  "switchControl": {
                    "controlType": "SWITCH",
                    "name": "saveFavorite"
                  }
                }
              },
              {
                "decoratedText": {
                  "text": "Merge with existing contacts",
                  "switchControl": {
                    "controlType": "SWITCH",
                    "name": "mergeContact",
                    "selected": true
                  }
                }
              },
              {
                "buttonList": {
                  "buttons": [
                    {
                      "text": "Next",
                      "onClick": {
                        "action": {
                          "function": "openSequentialDialog"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Campos y representación JSON TextInput

Representación JSON
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  }
}
Campos
name

string

Nombre con el que se identifica la entrada de texto en un evento de entrada del formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

label

string

El texto que aparece sobre el campo de entrada de texto en la interfaz de usuario.

Especifica el texto que ayuda al usuario a ingresar la información que necesita tu app. Por ejemplo, si le solicitas el nombre a alguien, pero necesitas específicamente su apellido, escribe "apellido" en lugar de "nombre".

Es obligatorio si no se especifica hintText . De lo contrario, es opcional.

hintText

string

Texto que aparece debajo del campo de entrada de texto con el propósito de ayudar a los usuarios al solicitarles que ingresen un valor determinado. Este texto siempre es visible.

Es obligatorio si no se especifica label . De lo contrario, es opcional.

value

string

El valor que ingresó un usuario, que se muestra como parte de un evento de entrada del formulario.

Para obtener detalles sobre cómo trabajar con entradas de formularios, consulta Cómo recibir datos de formularios.

type

enum ( Type )

Cómo aparece un campo de entrada de texto en la interfaz de usuario Por ejemplo, si el campo es de una o varias líneas.

onChangeAction

object ( Action )

Qué hacer cuando se produce un cambio en el campo de entrada de texto.

Algunos ejemplos de cambios incluyen un usuario que agrega el campo o que borra el texto.

Algunos ejemplos de acciones que se pueden realizar incluyen ejecutar una función personalizada o abrir un diálogo en Google Chat.

initialSuggestions

object ( Suggestions )

Valores sugeridos que los usuarios pueden ingresar. Estos valores aparecen cuando los usuarios hacen clic dentro del campo de entrada de texto. A medida que los usuarios escriben, los valores sugeridos se filtran de forma dinámica para coincidir con lo que escriben los usuarios.

Por ejemplo, un campo de entrada de texto para el lenguaje de programación puede sugerir Java, JavaScript, Python y C++. Cuando los usuarios comienzan a escribir "Jav", la lista de filtros de sugerencias muestra únicamente Java y JavaScript.

Los valores sugeridos ayudan a los usuarios a ingresar valores que pueden comprender tu app. Cuando hacen referencia a JavaScript, algunos usuarios pueden ingresar "javascript" y otros, "java script". Sugerir "JavaScript" puede estandarizar la forma en que los usuarios interactúan con la app.

Cuando se especifica, TextInput.type siempre es SINGLE_LINE , incluso si está configurado en MULTIPLE_LINE .

autoCompleteAction

object ( Action )

Opcional. Especifica qué acción realizar cuando el campo de entrada de texto brinda sugerencias a los usuarios que interactúan con él.

Si no se especifica, initialSuggestions establece las sugerencias, y el cliente las procesa.

Si se especifica, la app realiza la acción que se especifica aquí, como ejecutar una función personalizada.

Compatible con los complementos de Google Workspace, pero no con las apps de Chat. Pronto se admitirán las apps de chat.

Campos y representación JSON Suggestions

Representación JSON
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Campos
items[]

object ( SuggestionItem )

Una lista de sugerencias usadas para autocompletar recomendaciones en campos de entrada de texto.

Campos y representación JSON SuggestionItem

Representación JSON
{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Campos

Campo de unión content

content solo puede ser una de las siguientes opciones:

text

string

El valor de una entrada sugerida para un campo de entrada de texto. Esto equivale a lo que los usuarios ingresarían.