Button

Um botão de texto, ícone ou texto e ícone em que os usuários podem clicar. Para ver um exemplo em apps do Google Chat, consulte Adicionar um botão.

Para transformar uma imagem em um botão clicável, especifique um Image (não um ImageComponent) e defina uma ação onClick.

Disponível para apps do Google Chat e complementos do Google Workspace.

Representação JSON
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}
Campos
text

string

O texto exibido dentro do botão.

icon

object (Icon)

Um ícone exibido dentro do botão. Se icon e text forem definidos, o ícone vai aparecer antes do texto.

color

object (Color)

Opcional. A cor do botão. Se definido, o botão type é definido como FILLED, e a cor dos campos text e icon é definida como uma cor contrastante para facilitar a leitura. Por exemplo, se a cor do botão for azul, o texto ou os ícones nele serão brancos.

Para definir a cor do botão, especifique um valor para os campos red, green e blue. O valor precisa ser um número flutuante entre 0 e 1 com base no valor de cor RGB, em que 0 (0/255) representa a ausência de cor e 1 (255/255) representa a intensidade máxima da cor.

Por exemplo, o código a seguir define a cor como vermelho na intensidade máxima:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

O campo alpha não está disponível para a cor do botão. Se especificado, esse campo será ignorado.

onClick

object (OnClick)

Obrigatório. A ação a ser realizada quando um usuário clica no botão, como abrir um hiperlink ou executar uma função personalizada.

disabled

boolean

Se for true, o botão vai ser exibido em um estado inativo e não vai responder às ações do usuário.

altText

string

O texto alternativo usado para acessibilidade.

Defina um texto descritivo que informe aos usuários o que o botão faz. Por exemplo, se um botão abrir um hiperlink, você pode escrever: "Abre uma nova guia do navegador e acessa a documentação para desenvolvedores do Google Chat em https://developers.google.com/workspace/chat".

type

enum (Type)

Opcional. O tipo de um botão. Se não for definido, o tipo de botão será OUTLINED por padrão. Se o campo color estiver definido, o tipo de botão será forçado para FILLED, e qualquer valor definido para esse campo será ignorado.

Tipo

Opcional. O tipo de um botão. Se o campo color estiver definido, o type será forçado para FILLED.

Disponível para apps do Google Chat e indisponível para complementos do Google Workspace.

Tipos enumerados
TYPE_UNSPECIFIED Não use. Não especificado.
OUTLINED Os botões contornados são de prioridade média. Eles geralmente contêm ações importantes, mas que não são as principais em um app do Chat ou complemento.
FILLED Um botão preenchido tem um contêiner com uma cor sólida. Ele tem o maior impacto visual e é recomendado para a ação importante e principal em um app do Chat ou complemento.
FILLED_TONAL Um botão tonal preenchido é um meio-termo entre os botões preenchidos e os contornados. Eles são úteis em contextos em que um botão de prioridade mais baixa requer um pouco mais de ênfase do que um botão de contorno daria.
BORDERLESS Um botão não tem um contêiner invisível no estado padrão. Costuma ser usado para ações de menor prioridade, especialmente ao apresentar várias opções.