Overzicht
Een UI-element waarmee gebruikers kunnen zoeken naar berichten in een kanaal, DM of supportchat.Gebruik
Basisgebruik
Gebruiken als modal
Events
Events die door de SearchElement worden uitgezonden. Luister naar deze events met de methodeon() of door callbackfuncties mee te geven in de opties.
error
Wordt uitgezonden wanneer er een fout optreedt tijdens de initialisatie of werking van het element.
Callback-signatuur: (error: unknown) => void
ready
Wordt uitgezonden wanneer het element klaar is met laden en gereed is voor gebruikersinteractie.
Callback-signatuur: (element: SearchElement) => void
optionsUpdated
Wordt uitgezonden wanneer de opties van het element worden bijgewerkt via updateOptions().
Callback-signatuur: (options: SearchElementOptions) => void
snapshot
Wordt uitgezonden wanneer de interne status van het element verandert.
Callback-signatuur: (snapshot: SearchElementSnapshot) => void
close
Wordt uitgezonden wanneer de gebruiker het zoekelement sluit.
Roep ev.preventDefault() aan om te voorkomen dat het element automatisch wordt ontkoppeld.
Callback-signatuur: (ev: CustomEvent<any>) => void
resultClick
Callback die wordt aangeroepen wanneer de gebruiker op een zoekresultaat klikt.
Roep ev.preventDefault() aan om te voorkomen dat het element automatisch wordt ontkoppeld.
Callback-signatuur: (ev: CustomEvent<{ messageId: string; channelId: string; }>) => void
Methoden
mount(container)
Koppel het element aan een DOM-container.
De container moet een leeg element zijn. Het element wordt als child toegevoegd.
Als het element al gekoppeld is, logt deze methode een waarschuwing en keert terug.
unmount()
Verwijder het element uit de DOM en ruim alle event listeners op.
Na het ontkoppelen mag de elementinstantie niet opnieuw worden gebruikt.
Maak een nieuwe elementinstantie aan als je opnieuw wilt koppelen.
updateOptions(options)
Werk de configuratieopties van het element bij na het aanmaken.
Alleen de opgegeven opties worden bijgewerkt; andere opties blijven ongewijzigd.
Het element wordt opnieuw gerenderd met de nieuwe opties.
getSnapshot()
Haal de huidige status-snapshot van het element op.
De snapshot bevat de huidige interne status van het element, zoals
de laadstatus, formulierwaarden of andere elementspecifieke gegevens.
Retourneert: SearchElementSnapshot
Styling
Pas dit element aan metappearance.classes. Zie de stylingreferentie voor de volledige lijst met stabiele klassenamen en voorbeeldsnippets.
Types
SearchElementOptions
Configuratieopties voor de SearchElement.SearchElementSnapshot
Vertegenwoordigt de huidige status van de SearchElement. Gebruikelement.getSnapshot() om de huidige status op te halen, of luister naar het event snapshot voor wijzigingen.

