Pular para o conteúdo
Formulário

TagsInput

/componentes/tags-input.mdmarkdown cru, para quem lê com agent em vez de olho

Marcadores do chamado

urgenterevisar

Enter fecha a ficha; apagar com o campo vazio tira a última.

Convite com teto e separadores

financeiro@clinicasaolucas.com.br

Até 3 convites. Vírgula, ponto e vírgula ou espaço fecham a ficha, e colar uma lista também vale.

Importar
import { TagsInput } from '@rivocode/ui'

Quando usar

Lista de marcadores que a pessoa escreve: etiquetas de um chamado, palavras de um filtro, emails de um convite.

Três gestos que a peça resolve de uma vez, para não serem resolvidos cinco vezes diferentes: o Enter fecha a ficha, o Backspace com o campo vazio tira a última (é o gesto que todo mundo tenta primeiro) e a repetida não entra duas vezes, porque marcar duas vezes a mesma coisa nunca é o que se quis. Sair do campo também fecha o que estava escrito: texto digitado e não fechado some ao enviar o formulário, e ninguém entende por quê.

Colar uma lista separada pelos separators, ou por quebra de linha, vira uma ficha para cada item. Com max, o campo para de aceitar ficha nova no teto, mas continua focado: o Backspace ainda tira a última. Com name, o formulário nativo recebe cada ficha com esse nome, e nunca o texto pela metade.

Guarda a própria lista quando recebe só defaultValue, e obedece à de fora quando recebe value, o mesmo par das outras peças de formulário. Num formulário que envia, controle: quem guarda a lista é o app, porque é ele que a manda. Num filtro de tela, que não envia nada, defaultValue poupa o useState.

<TagsInput defaultValue={['urgente']} aria-label="Palavras do filtro" />

O rótulo

Embrulhe num Field com FieldLabel, como qualquer campo da casa. O campo de escrever passa pelo Field.Control: é ele, e não a moldura das fichas, que recebe o id do rótulo, o aria-describedby da ajuda e do erro, e o aria-invalid. Clicar no rótulo foca o campo, e a moldura fica vermelha quando o Field está inválido.

<Field>
  <FieldLabel>Marcadores</FieldLabel>
  <TagsInput value={tags} onValueChange={setTags} placeholder="Escreva e tecle Enter" />
  <FieldDescription>Enter fecha a ficha.</FieldDescription>
</Field>

O placeholder não é rótulo: ele some no instante em que a pessoa digita, e vários leitores de tela não o anunciam. Fora de um Field, dê aria-label.

O anel de foco é do campo de escrever, e não da moldura. O xis de cada ficha tem anel próprio, e os dois nunca acendem juntos.

Tirar uma ficha pelo xis não joga o foco para o começo da página: ele vai para o xis da ficha seguinte, ou da anterior quando era a última, e para o campo de escrever quando não sobra nenhuma.

O nome do xis

Cada ficha diz o que se remove: labels.remove recebe o texto dela e devolve o nome que o leitor de tela ouve. Sem isso, uma fila de fichas se anuncia "Remover, Remover, Remover", e quem depende do leitor não sabe qual botão é qual.

<TagsInput
  defaultValue={['urgente']}
  aria-label="Marcadores"
  labels={{ remove: (tag) => `Tirar o marcador ${tag}` }}
/>

Movimento

Só a ficha que chega depois cresce ao entrar (animate-pop, --rc-duration-fast). As que já vinham no valor nascem paradas: elas são o formulário, e não algo que acabou de acontecer.

Quando não usar

Quando as opções já existem, use Combobox com multiple e as fichas: ele mostra o catálogo antes de deixar escolher. O TagsInput é para quando a lista nasce do que se digita e não há o que sugerir.

No React Native

Traduz, com um gesto a menos. O Enter fecha a ficha e o separador digitado também, mas ele é lido no texto, e não na tecla, porque o onKeyPress do Android não chega para o teclado do sistema. É esse mesmo evento que faltava para o Backspace com o campo vazio tirar a última ficha, e por isso ele não porta: no celular a ficha se tira pelo xis, que já precisava existir para o dedo. O resto é igual: a peça é controlada, a repetida não entra duas vezes e sair do campo fecha o que estava meio escrito. O nome do xis vem por labels.remove, como no web.

As partes vestem pelo mesmo classNames do web: field, tag, remove e input.

API

PropTipoPadrão
classNames0.5.0

Classe por parte: `field`, `tag`, `remove`, `input`.

Partial<Record<"field" | "input" | "remove" | "tag", string>>sem padrão
defaultValue

As fichas do primeiro desenho, quando a peca guarda a propria lista.

string[]sem padrão
labels

O que o leitor de tela ouve nos botoes da peca.

{ remove?: ((tag: string) => string) | undefined; }sem padrão
max0.5.0

Teto de fichas.

numbersem padrão
name

Cada ficha vai ao formulario nativo como um campo com este nome, e o texto pela metade nao vai.

stringsem padrão
onValueChange0.5.0

Avisado com a lista inteira a cada ficha que entra ou sai.

((value: string[]) => void)sem padrão
separators0.5.0

O que fecha uma ficha alem do Enter.

string[]sem padrão
size

A altura vazia e o recuo do texto, os mesmos do `Input` do mesmo tamanho.

ControlSize"md"
value0.5.0

As fichas de agora, quando quem usa guarda a lista.

string[]sem padrão

Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.

@rivocode/ui, 149 peças no catálogo. Esta página é gerada dos mesmos arquivos que alimentam o design system, então ela não envelhece sozinha.

Feito por RivoCode.