Chatbox

interface Chatbox

A messaging UI for just a single conversation

There is no way for the user to switch between conversations (but you can change the active conversation through select). Create a Chatbox through Session​.createChatbox and then call mount to show it.

Available Methods

createHtmlPanel

Puts custom HTML just above the message field.

destroy

Destroys the chatbox and removes it from the DOM

mount

Renders the Chatbox UI inside a DOM element on your page.

off

Used to stop listening to TalkJS events.

on("blur")

Triggers when the chat UI gets unfocused

on("focus")

Triggers when the chat UI gets focused

on("sendMessage")

Triggers when the user sends a message using the TalkJS UI

on("translationToggled")

Triggers when the user toggles translation in a conversation

select

Switches the active conversation the conversation.

setHighlightedWords

Highlights certain words in messages

setMessageFilter

Used to control which messages are shown in the message list

setPresence

Sets metadata for the current session.

setTranslationEnabledDefault

Enable/disable translation by default.

setTranslationEnabledFor­Conversation

Enable or disable translation for a conversation.

toggleDesktopNotifications Deprecated

Please use Session​.setDesktopNotification­Enabled instead.

Available Properties

messageField
: MessageField

Encapsulates the message entry field tied to the currently selected conversation.

createHtmlPanel

chatbox.createHtmlPanel(options): Promise<HtmlPanel>
Puts custom HTML just above the message field.

Using HTML Panels, you can extend TalkJS UIs to have anything from credit card payments to lead collection forms, or, for instance, to show the product details of a marketplace transaction between your users. See our HTMLPanels documentation for more info.

Parameters

interface HtmlPanelOptions
conversation (optional)
: Conversation | ConversationBuilder | string

Either a Conversation object (as returned from getOrCreateConversation) or the id field of a conversation (which you may have stored in your database). If given the HTML panel called will only show up for that conversation.

height (optional)
: number

Optional, defaults to 100 (px).

show (optional)
: boolean

Optional, defaults to true. Set false if you don't want the HTML panel to be shown after createHtmlPanel is called. You can change the visibility of the HTML panels by calling .hide() or .show() on the HtmlPanel instance returned by createHtmlPanel's promise.

url
: string

Required. URL you want to load inside the HTML panel. Url can be absolute ("https://www.example.com/register-form.html") or relative ("register-form.html"). We recommend using same origin pages to have better control of the page. Learn more about HTML Panels and same origin pages here.

Returns

Promise<HtmlPanel>

destroy

chatbox.destroy()
Destroys the chatbox and removes it from the DOM

Destroys the chatbox, removes it from the DOM and removes all event listeners it has running. Call this before removing the chatbox container from the DOM.

Parameters

None.

Returns

void

mount

chatbox.mount(container): Promise<void>
Renders the Chatbox UI inside a DOM element on your page.

The container element specified by container must either be a DOM Element (as returned by e.g. document.getElementById) or a JQuery object with a single element.

Parameters

container
: HTMLElement | JQuery | null

Returns

Promise<void>

off

This method has 5 overloads
chatbox.off(eventType, handler)
Used to stop listening to TalkJS events.

Stops listening for the _sendMessage_ event

Parameters

eventType
: "sendMessage"
handler
: (event: SendMessageEvent) => void

The handler function must be the same handler function that was passed to on("sendMessage")

Returns

void
chatbox.off(eventType, handler)
Used to stop listening to TalkJS events.

Stops listening for the _sendMessage_ event

Parameters

eventType
: "sendMessage"
handler
: (event: SendMessageEvent) => void

The handler function must be the same handler function that was passed to on("close")

Returns

void
chatbox.off(eventType, handler)
Used to stop listening to TalkJS events.

Stops listening for the _focus_ event

Parameters

eventType
: "focus"
handler
: () => void

The handler function must be the same handler function that was passed to on("focus")

Returns

void
chatbox.off(eventType, handler)
Used to stop listening to TalkJS events.

Stops listening for the _blur_ event

Parameters

eventType
: "blur"
handler
: () => void

The handler function must be the same handler function that was passed to on("blur")

Returns

void
chatbox.off(eventType, handler)
Used to stop listening to TalkJS events.

Stops listening for the _translationToggled_ event

Parameters

eventType
: "translationToggled"
handler
: () => void

The handler function must be the same handler function that was passed to on("translationToggled")

Returns

void

on("blur")

chatbox.on(eventType, handler)
Triggers when the chat UI gets unfocused

Emits an event when the user clicks/taps anywhere outside the chat UI.

Parameters

eventType
: "blur"
handler
: (event: BlurEvent) => void

Returns

void

on("focus")

chatbox.on(eventType, handler)
Triggers when the chat UI gets focused

Emits an event when the user clicks/taps anywhere inside the chat UI.

Parameters

eventType
: "focus"
handler
: (event: FocusEvent) => void

Returns

void

on("sendMessage")

chatbox.on(eventType, handler)
Triggers when the user sends a message using the TalkJS UI

Parameters

eventType
: "sendMessage"
handler
: (event: SendMessageEvent) => void

Returns

void

on("translationToggled")

chatbox.on(eventType, handler)
Triggers when the user toggles translation in a conversation

Parameters

eventType
: "translationToggled"
handler
: (event: TranslationToggledEvent) => void

Returns

void

select

This method has 2 overloads
chatbox.select(conversation)
Switches the active conversation the conversation.

conversation can be either a ConversationBuilder object or a TalkJS conversation id. Passing null means that the conversation will be de-selected in the UI and the message list will disappear. Passing undefined means that the last conversation (or "no chats yet" page if there are no other conversations) will be rendered in the message list component.

Parameters

conversation
: string | Conversation | ConversationBuilder | null | undefined

Returns

void
chatbox.select(conversation, params)
Switches the active conversation the conversation.

conversation can be either a ConversationBuilder object or a TalkJS conversation id. Passing null means that the conversation will be de-selected in the UI and the message list will disappear. Passing undefined means that the last conversation (or "no chats yet" page if there are no other conversations) will be rendered in the message list component.

Parameters

conversation
: string | Conversation | ConversationBuilder | null | undefined
params (optional)
: { asGuest?: boolean }

Selection parameters. asGuest can be used to select the conversation as a guest, with limited functions

Returns

void

setHighlightedWords

chatbox.setHighlightedWords(words)
Highlights certain words in messages

The TalkJS search feature includes the ability to highlight certain words in messages. Call this method to highlight certain words without having the user invoke the search feature. Call again with an empty array to disable highlighting.

Note: like the search feature, this option only works on the Growth plan and up.

Also see ChatboxOptions​.highlightedWords

Parameters

words
: string[]

Returns

void

setMessageFilter

chatbox.setMessageFilter(filter)
Used to control which messages are shown in the message list

Lets you filter messages depending on a type, origin or custom message attributes.

Note: Messages are only filtered in the message list. The inbox UI's conversation feed will always show the last message sent to the conversation, regardless of the message filter set.

See MessagePredicate for all available options.

Example

// only show messages sent by users with role "admin"
chatbox.setMessageFilter({
sender: {
role: ["==", "admin"],
}
});

Parameters

A predicate object that controls which messages are shown.

Returns

void

setPresence

chatbox.setPresence(params)
Sets metadata for the current session.

Parameters

params
: { visible?: boolean custom?: {[key: string]: string }}

Object with presence parameters.

- visible manually sets the information about the visibility of TalkJS. This is useful when TalkJS is hidden with CSS. TalkJS will assume that UIs marked visible: false cannot be seen, and thus messages arriving on this UI will not be marked as read until you set visible to true again.

- custom is an additional parameter to store the custom fields, that you may want to use in the REST API call.

Returns

void

setTranslationEnabledDefault

chatbox.setTranslationEnabledDefault(enabled)
Enable/disable translation by default.

This setting is applied to any conversation for which you haven't set a specific value.

Parameters

enabled
: boolean | "auto"

Whether conversations should be translated by default or not. Pass "auto" to enable translation for conversations with users with different locales.

Returns

void

setTranslationEnabledForConversation

chatbox.setTranslationEnabledForConversation(conversation, enabled)
Enable or disable translation for a conversation.

Parameters

conversation
: string | ConversationBuilder

The conversation for which this should be set. If not specified, the setting will be applied to the currently selected conversation.

enabled
: boolean

Whether translation should be enabled

Returns

void

Deprecated Methods

Deprecated toggleDesktopNotifications

chatbox.toggleDesktopNotifications(isEnabled)
Please use Session​.setDesktopNotification­Enabled instead.

This method will keep being supported, but for new projects, we recommend that you use Session​.setDesktopNotification­Enabled.

Sets desktop notification on or off. Has the same effect as toggling the "Desktop notification" toggle in the TalkJS Inbox UI. Use this function to replicate that toggle elsewhere in your UI if you're using TalkJS in a mode that doesn't show this toggle.

Deprecated.

Parameters

isEnabled
: boolean

Returns

void