@talkjs/web-components

Web Components for TalkJS

The @talkjs/web-components library provides chat UI components for TalkJS.

Prerequisites

To use this package, you will need a TalkJS account. TalkJS provides a ready-to-use chat client for your application. Your account gives you access to TalkJS's free development environment.

Examples

Install @talkjs/web-components:

npm install @talkjs/web-components
# or
yarn add @talkjs/web-components

Import from @talkjs/web-components to register the <t-chatbox> custom element. Also import the related styling into the component where you want to have your chat UI:

import "@talkjs/web-components";
import "@talkjs/web-components/default.css";

Then add the Chatbox component:

<t-chatbox
  app-id="<APP_ID>"
  user-id="sample_user_alice"
  conversation-id="sample_conversation"
></t-chatbox>

Replace the <APP_ID> with your TalkJS app ID, which you can find in the Settings tab of the TalkJS dashboard.

For more details, see our framework-specific guides: Vue, Angular, Svelte.

Support

If you encounter any problems with @talkjs/web-components, please open a chat with support. TalkJS support is staffed by engineers.