Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PopupOptions

Hierarchy

Index

Properties

Optional chatSubtitleMode

chatSubtitleMode: "subject" | "participants" | null

Controls what text appears in the chat subtitle, right below the chat title. No subtitle is displayed when the conversation has no subject set or when set to null. Defaults to "subject".

(also see ChatboxOptions.chatTitleMode and InboxOptions.feedConversationTitleMode)

Optional chatTitleMode

chatTitleMode: "subject" | "participants"

Controls what text appears in the chat title, in the header above the messages. Defaults to "participants".

(also see ChatboxOptions.chatSubtitleMode and InboxOptions.feedConversationTitleMode)

Optional dir

dir: "rtl" | "ltr"

Optional. Controls the text direction (for supporting right-to-left languages such as Arabic and Hebrew). TalkJS tries to determine the appropriate text direction from the parent page, but if that does not work or you want to explicitly control it, you can override it here.

Optional keepOpen

keepOpen: undefined | true | false

Optional, defaults to true. If enabled, the Popup will reopen every time the user navigates to another page. This way, a conversation can continue while the user browses around. Set to false to disable this behavior.

Optional launcher

launcher: "close-only" | "always" | "never"

Optional, defaults to "close-only". Specifies whether to show a round launcher and/or close button beneath the popup in the right bottom corner of the page.

  • "close-only": show a close button beneath the popup, but don't show a launch button
  • "always": show a launch button when the popup is closed, show a close button when it is visible
  • "never": never show a launcher

Note: if you choose "never" you may want to override the positioning of the popup as well. Just tune the __talkjs_popup class in your CSS.

Ignored on mobile, where the popup fills the entire screen so the value is effectively "never".

Optional messageSuggestion

messageSuggestion: undefined | string

Optional. Sets the message input box to the given text. You can use this to suggest a certain initial message to be sent. The user can still edit it before hitting "send".

Optional showChatHeader

showChatHeader: undefined | true | false

Optional, defaults to true. Set to false to make TalkJS display the chat without its header (the upper bar that shows names and the user's photo).

Optional showCloseInHeader

showCloseInHeader: boolean | "auto"

Optional. Whether to show a little "x" in the popup header to close the popup. "auto", which is the default value means true on mobile and to false on desktop.

Optional thirdparties

thirdparties: ThirdPartyOptions

TalkJS leverages iframes behind the scenes and therefore not all services that you use in your app will work out of the box. This option adds support for a number of services to help you use them. Let us know if you're missing any.

Generated using TypeDoc