Pular para o conteúdo
Formulário

SearchInput

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

Padrão

Com atalho

Alimentando uma tabela

ProntuárioPaciente
2201Ana Ribeiro
2202Bruno Esteves
2203Conceição Araújo
Conteúdo carregado
Importar
import { SearchInput } from '@rivocode/ui'

Quando usar

O campo de busca com a lupa no lugar: o arranjo que toda listagem montava na mão com position: absolute.

Sai como <input type="search">, então o leitor de tela anuncia "busca" e o Esc limpa. Sem onClear, o Esc passa pelo mesmo caminho da digitação: o onChange e o onValueChange recebem o texto vazio, e o campo controlado limpa quando o estado de quem usa aceita. Com onClear, limpar é com ele.

onValueChange entrega o texto a cada tecla, como no Input e no SearchInput do React Native. Com ele, o campo controlado é value mais onValueChange, sem tirar o texto de dentro do evento. O onChange do DOM continua chamado junto.

Vazio, ele espera com "Buscar". Prefira um placeholder que diga por onde a busca procura, como "Buscar por número ou cliente": o padrão é a rede, e não o texto certo da sua tela.

const [filter, setFilter] = useState("");

<SearchInput aria-label="Buscar paciente" value={filter} onValueChange={setFilter} />

shortcut mostra o atalho num Kbd dentro do campo ("mod+k" sai ⌘K no Mac e Ctrl K no resto). Só o desenho: registrar o atalho é trabalho de quem monta a tela, porque é ela que sabe o que mais escuta teclado.

className veste a caixa em volta, que leva a lupa e o atalho: é nela que mora a largura (className="max-w-xs", className="min-w-0 flex-1"). O próprio campo recebe a classe por classNames.input, como no resto da casa.

<SearchInput aria-label="Buscar paciente" className="max-w-xs" classNames={{ input: "font-mono" }} />

Combina com o filter do DataTable: o campo fica onde a tela pedir e a tabela só recebe o texto.

Quando não usar

Para achar qualquer tela, cliente ou pedido de qualquer lugar do app, use Command: a paleta abre no Ctrl+K e leva até a coisa. O SearchInput só filtra a lista que já está na tela.

Quando a busca serve para escolher um valor e guardá-lo, é Combobox, que abre o painel e lembra o item escolhido; com texto livre que aceita sugestão, é Autocomplete. Aqui não há painel nem escolha.

No React Native

Traduz, com value e onValueChange obrigatórios: no nativo tudo é controlado. O className veste a caixa em volta, como no web, e classNames.input veste o próprio campo, com o nome do web.

API

PropTipoPadrão
classNames

Classe por parte: `input` e o proprio campo.

Partial<Record<"input", string>>sem padrão
onClear0.4.0

Chamado no Esc.

(() => void)sem padrão
onValueChange

Recebe o texto a cada tecla, como no `Input` e no SearchInput nativo.

((value: string) => void)sem padrão
placeholder

O texto de espera do campo vazio.

string"Buscar"
shortcut0.4.0

O atalho que abre ou foca a busca, mostrado num `Kbd` dentro do campo: `"mod+k"`.

stringsem padrão
size

A altura do campo.

"lg""md""sm""md"

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.