Skip to main content

Oversigt

Et UI-element, der lader brugere søge efter beskeder i en kanal, en DM eller en supportchat.

Brug

Grundlæggende brug

Brug som modal

Hændelser

Hændelser, der udsendes af SearchElement. Lyt efter disse hændelser med metoden on() eller ved at sende callback-funktioner med i indstillingerne.

error

Udsendes, når der opstår en fejl under elementets initialisering eller drift. Callback-signatur: (error: unknown) => void

ready

Udsendes, når elementet er færdig med at indlæse og er klar til brugerinteraktion. Callback-signatur: (element: SearchElement) => void

optionsUpdated

Udsendes, når elementets indstillinger opdateres via updateOptions(). Callback-signatur: (options: SearchElementOptions) => void

snapshot

Udsendes, når elementets interne tilstand ændres. Callback-signatur: (snapshot: SearchElementSnapshot) => void

close

Udsendes, når brugeren lukker søgeelementet. Kald ev.preventDefault() for at forhindre, at elementet automatisk afmonteres. Callback-signatur: (ev: CustomEvent<any>) => void

resultClick

Callback, der udløses, når brugeren klikker på et søgeresultat. Kald ev.preventDefault() for at forhindre, at elementet automatisk afmonteres. Callback-signatur: (ev: CustomEvent<{ messageId: string; channelId: string; }>) => void

Metoder

mount(container)

Monter elementet i en DOM-container. Containeren skal være et tomt element. Elementet tilføjes som et underelement. Hvis elementet allerede er monteret, logger denne metode en advarsel og returnerer.

unmount()

Fjern elementet fra DOM’en, og ryd op i alle event listeners. Efter afmontering bør elementinstansen ikke genbruges. Opret en ny elementinstans, hvis du skal montere igen.

updateOptions(options)

Opdater elementets konfigurationsindstillinger efter oprettelse. Kun de angivne indstillinger opdateres; andre indstillinger forbliver uændrede. Elementet gengives igen med de nye indstillinger.

getSnapshot()

Hent det aktuelle tilstands-snapshot af elementet. Snapshottet indeholder elementets aktuelle interne tilstand, såsom indlæsningsstatus, formularværdier eller andre elementspecifikke data. Returnerer: SearchElementSnapshot

Styling

Tilpas dette element med appearance.classes. Se styling-referencen for den fulde liste over stabile klassenavne og eksempelsnippets.

Typer

SearchElementOptions

Konfigurationsindstillinger for SearchElement.

SearchElementSnapshot

Repræsenterer den aktuelle tilstand af SearchElement. Brug element.getSnapshot() til at hente den aktuelle tilstand, eller lyt efter snapshot-hændelsen for ændringer.