Partager via


SearchBox contrôle (version préliminaire)

[Cet article fait partie de la documentation en version préliminaire et peut faire l’objet de modifications.]

Un contrôle utilisé pour créer une expérience de recherche.

Contrôle SearchBox.

Description

Une zone de recherche (SearchBox) fournit un champ de saisie pour rechercher dans un site ou une application afin de trouver des éléments spécifiques.

Ce composant de code fournit un wrapper autour du contrôle Fluent UI SearchBox à utiliser dans les applications canevas et les pages personnalisées.

Important

  • Cette fonctionnalité est en version préliminaire.
  • Les fonctionnalités en version préliminaire ne sont pas destinées à une utilisation en production et peuvent être restreintes. Ces fonctionnalités sont disponibles avant une publication officielle afin que les clients puissent y accéder de façon anticipée et fournir des commentaires.

Propriétés principales

Property Description
SearchText Texte saisi par l’utilisateur. Référez-vous à cela comme entrée pour les fonctions de recherche.
IconName Nom de l’icône Fluent UI à utiliser (voir Icônes Fluent UI).
Underlined Si la zone de recherche SearchBox est soulignée ou non.
DisableAnimation S’il faut ou non animer l’icône SearchBox du focus.
PlaceholderText Espace réservé pour le champ de recherche.

Propriétés supplémentaires

Property Description
Theme L’objet Theme (pas au format Json). Consultez Création de thèmes pour obtenir des instructions de configuration.
AccessibilityLabel Étiquette aria pour les lecteurs d’écran.
InputEvent Un événement à envoyer au contrôle. Par exemple, SetFocus.

Exemple

Configurer le comportement de recherche

Ajoutez ce contrôle à votre application où vous avez besoin d’une interface de recherche, généralement couplée à une galerie, DetailsList, ou à un contrôle qui peut afficher un jeu de données.

Créez une expérience de recherche en utilisant les expressions Search() ou Filter() qui utilisent la valeur de la propriété SearchText du contrôle SearchBox.

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

Limitations

Ce composant de code ne peut être utilisé que dans les applications canevas et les pages personnalisées.