Skip to main content

Descripción general

Un elemento de interfaz que permite a los usuarios buscar mensajes en un canal, mensaje directo o chat de soporte.

Uso

Uso básico

Uso como modal

Eventos

Eventos emitidos por el SearchElement. Escucha estos eventos con el método on() o pasando funciones de callback en las opciones.

error

Se emite cuando ocurre un error durante la inicialización o el funcionamiento del elemento. Firma del callback: (error: unknown) => void

ready

Se emite cuando el elemento ha terminado de cargarse y está listo para la interacción del usuario. Firma del callback: (element: SearchElement) => void

optionsUpdated

Se emite cuando las opciones del elemento se actualizan mediante updateOptions(). Firma del callback: (options: SearchElementOptions) => void

snapshot

Se emite cuando cambia el estado interno del elemento. Firma del callback: (snapshot: SearchElementSnapshot) => void

close

Se emite cuando el usuario cierra el elemento de búsqueda. Llama a ev.preventDefault() para evitar que el elemento se desmonte automáticamente. Firma del callback: (ev: CustomEvent<any>) => void

resultClick

Callback que se ejecuta cuando el usuario hace clic en un resultado de búsqueda. Llama a ev.preventDefault() para evitar que el elemento se desmonte automáticamente. Firma del callback: (ev: CustomEvent<{ messageId: string; channelId: string; }>) => void

Métodos

mount(container)

Monta el elemento en un contenedor del DOM. El contenedor debe ser un elemento vacío. El elemento se añadirá como hijo. Si el elemento ya está montado, este método registrará una advertencia y retornará.

unmount()

Elimina el elemento del DOM y limpia todos los listeners de eventos. Después de desmontarla, la instancia del elemento no debe reutilizarse. Crea una nueva instancia del elemento si necesitas montarlo de nuevo.

updateOptions(options)

Actualiza las opciones de configuración del elemento después de su creación. Solo se actualizarán las opciones proporcionadas; las demás permanecen sin cambios. El elemento se volverá a renderizar con las nuevas opciones.

getSnapshot()

Obtiene la instantánea del estado actual del elemento. La instantánea contiene el estado interno actual del elemento, como el estado de carga, los valores del formulario u otros datos específicos del elemento. Devuelve: SearchElementSnapshot

Estilos

Personaliza este elemento con appearance.classes. Consulta la referencia de estilos para ver la lista completa de nombres de clase estables y fragmentos de ejemplo.

Tipos

SearchElementOptions

Opciones de configuración del SearchElement.

SearchElementSnapshot

Representa el estado actual del SearchElement. Usa element.getSnapshot() para obtener el estado actual, o escucha el evento snapshot para detectar cambios.