Vue d’ensemble
Un élément d’interface qui permet aux utilisateurs de rechercher des messages dans un canal, un message privé ou un chat d’assistance.Utilisation
Utilisation de base
Utilisation en tant que modale
Événements
Événements émis par le SearchElement. Écoutez ces événements avec la méthodeon() ou en passant des fonctions de rappel dans les options.
error
Émis lorsqu’une erreur se produit pendant l’initialisation ou le fonctionnement de l’élément.
Signature du callback : (error: unknown) => void
ready
Émis lorsque l’élément a fini de se charger et est prêt pour l’interaction de l’utilisateur.
Signature du callback : (element: SearchElement) => void
optionsUpdated
Émis lorsque les options de l’élément sont mises à jour via updateOptions().
Signature du callback : (options: SearchElementOptions) => void
snapshot
Émis lorsque l’état interne de l’élément change.
Signature du callback : (snapshot: SearchElementSnapshot) => void
close
Émis lorsque l’utilisateur ferme l’élément de recherche.
Appelez ev.preventDefault() pour empêcher l’élément de se démonter automatiquement.
Signature du callback : (ev: CustomEvent<any>) => void
resultClick
Callback déclenché lorsque l’utilisateur clique sur un résultat de recherche.
Appelez ev.preventDefault() pour empêcher l’élément de se démonter automatiquement.
Signature du callback : (ev: CustomEvent<{ messageId: string; channelId: string; }>) => void
Méthodes
mount(container)
Monte l’élément dans un conteneur DOM.
Le conteneur doit être un élément vide. L’élément y sera ajouté en tant qu’enfant.
Si l’élément est déjà monté, cette méthode affiche un avertissement et s’arrête.
unmount()
Retire l’élément du DOM et supprime tous les écouteurs d’événements.
Après le démontage, l’instance de l’élément ne doit pas être réutilisée.
Créez une nouvelle instance si vous devez monter l’élément à nouveau.
updateOptions(options)
Met à jour les options de configuration de l’élément après sa création.
Seules les options fournies sont mises à jour ; les autres restent inchangées.
L’élément est de nouveau rendu avec les nouvelles options.
getSnapshot()
Récupère l’instantané de l’état actuel de l’élément.
L’instantané contient l’état interne actuel de l’élément, comme
le statut de chargement, les valeurs de formulaire ou d’autres données propres à l’élément.
Retourne : SearchElementSnapshot
Style
Personnalisez cet élément avecappearance.classes. Consultez la référence de style pour la liste complète des noms de classes stables et des exemples de code.
Types
SearchElementOptions
Options de configuration du SearchElement.SearchElementSnapshot
Représente l’état actuel du SearchElement. Utilisezelement.getSnapshot() pour obtenir l’état actuel, ou écoutez l’événement snapshot pour suivre les changements.

