Controlo (pré-visualização) SearchBox

[Este artigo inclui documentação pré-versão e está sujeito a alterações.]

Um controlo utilizado para criar uma experiência de pesquisa.

Controlo SearchBox.

Description

Uma caixa de pesquisa (SearchBox) fornece um campo de entrada para pesquisar num site ou numa aplicação para encontrar itens específicos.

Este componente de código fornece um wrapper em torno do controlo Fluent UI SearchBox para utilização em quadros e páginas personalizadas.

Importante

  • Esta é uma funcionalidade de pré-visualização.
  • As funcionalidades de pré-visualização não se destinam a ser utilizadas em ambiente de produção e podem ter funcionalidades restritas. Esses recursos estão disponíveis antes de um lançamento oficial para que os clientes possam obter acesso antecipado e fornecer feedback.

Propriedades chave

Propriedade Description
SearchText Texto que é introduzido pelo utilizador. Consulte isto como a entrada para as funções de pesquisa.
IconName Nome do ícone da Fluent UI (consulte Ícones da Fluent UI).
Underlined Se SearchBox está sublinhado ou não.
DisableAnimation Se deve ou não animar o ícone da caixa de pesquisa quando estiver em foco.
PlaceholderText Marcador de posição para a caixa de pesquisa.

Propriedades adicionais

Propriedade Description
Theme O objeto de Tema (não formatado por JSON). Consulte personalizar o tema para obter orientações sobre como configurar.
AccessibilityLabel Nome ARIA para leitor de ecrã.
InputEvent Um evento a enviar ao controlo. Por exemplo, SetFocus.

Example

Configurar comportamento de pesquisa

Adicione este controlo à aplicação onde é necessário uma interface de pesquisa, normalmente, aliada a uma galeria, DetailsList, ou qualquer controlo que possa apresentar um conjunto de dados.

Crie uma experiência de pesquisa utilizando as expressões Search() ou Filter() que utilizam o valor da propriedade SearchText no SearchBox.

Search( Accounts, SearchBox.SearchText, "name" )

Limitations

Este componente de código só pode ser utilizado em aplicações canvas e páginas personalizadas.