Skip to main content

Descripción general

Un elemento de interfaz que muestra una interfaz de chat.

Uso

Uso básico

Escuchar eventos

Eventos

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

error

Se emite cuando se produce 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: ChatElement) => void

optionsUpdated

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

snapshot

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

profileClick

Se emite cuando el usuario hace clic en un perfil. Firma del callback: (ev: CustomEvent<{ id: string; }>) => void

linkClick

Se emite cuando el usuario hace clic en un enlace. Firma del callback: (ev: CustomEvent<{ url: string; }>) => void

messageSent

Se emite cuando el usuario envía un mensaje. Firma del callback: (ev: CustomEvent<{ id: string; content: string; channelId: string; }>) => void

messageDeleted

Se emite cuando el usuario elimina un mensaje. Firma del callback: (ev: CustomEvent<{ id: string; }>) => void

experienceClick

Se emite cuando el usuario hace clic en una mención de experiencia. Firma del callback: (ev: CustomEvent<{ id: string; }>) => void

attachmentClick

Se emite cuando el usuario hace clic en un archivo adjunto. Firma del callback: (ev: CustomEvent<{ messageId: string; attachments: AttachmentClickEventAttachment[]; }>) => 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 terminará.

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 volver a montarlo.

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 opciones no cambian. 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: ChatElementSnapshot

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

ChatElementOptions

Opciones de configuración del ChatElement.

ChatElementSnapshot

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