Installation on Svelte

This guide shows how to embed the XAPP Chat Widget inside a page of a Svelte 5 application, for example on a "Talk to us" page.

For the standard floating chat button on every page, you don't need any of this: add the script snippet to your app's index.html as described in Manual Installation.

tip

Try it first on the Embedded Chat Examples page — choose Svelte to see the source for different layouts.

How It Works

The chat widget is a React component. A small Svelte component creates a React root inside its own element when it mounts and removes it when it is destroyed, so the chat behaves like any other Svelte component. React is installed alongside your app.

Prerequisites

• A Svelte 5 application built with Vite, and a developer who can build and deploy it
• Your chat widget key from Studio
  • See instructions here

Installation Steps

1. Install the packages

   npm install @xapp/chat-widget react react-dom react-redux stentor-models

   (or yarn add / pnpm add with the same packages). For TypeScript, also install @types/react and @types/react-dom as dev dependencies.

2. Add the chat component — src/lib/XappChat.svelte

   <script lang="ts">
     import { onMount } from "svelte";
     import { createElement } from "react";
     import { createRoot, type Root } from "react-dom/client";
     import { Chat, type WidgetEnv } from "@xapp/chat-widget";
     import "@xapp/chat-widget/dist/index.css";
   
     const CHAT_KEY = "YOUR_CHAT_KEY";
   
     let container: HTMLDivElement;
   
     onMount(() => {
       let root: Root | null = null;
       let unmounted = false;
   
       (async () => {
         let studioConfig: WidgetEnv;
         try {
           const res = await fetch(`https://widget.xapp.ai/config.json?key=${CHAT_KEY}`);
           if (!res.ok) {
             throw new Error(`Chat config request failed: ${res.status}`);
           }
           studioConfig = await res.json();
         } catch (error) {
           // A network failure rejects fetch itself, so catch both that and a bad status.
           console.error(error);
           return;
         }
         if (unmounted) {
           return;
         }
         const config: WidgetEnv = {
           ...studioConfig,
           // The action bar is a floating page element; hide it inside an embedded chat.
           actionBar: studioConfig.actionBar && { ...studioConfig.actionBar, enabled: false },
         };
         root = createRoot(container);
         root.render(createElement(Chat, { config, mode: "docked" }));
       })();
   
       return () => {
         unmounted = true;
         root?.unmount();
       };
     });
   </script>
   
   <div bind:this={container} class="xapp-chat"></div>
   
   <style>
     .xapp-chat {
       height: 100%;
     }
   </style>

   Note! Please replace "YOUR_CHAT_KEY" with your actual widget key.

   For plain JavaScript, remove lang="ts", the type imports and the type annotations.

3. Place it in a container with a height

   In docked mode the chat fills the element it is placed in, so give that element a height (and a width if you want it narrower than the column):

   <script>
     import XappChat from "./lib/XappChat.svelte";
   </script>
   
   <h1>Talk to us</h1>
   <div style="height: 600px; max-width: 420px">
     <XappChat />
   </div>

note

If your app renders on the server (for example SvelteKit), the widget must only load in the browser — it reads browser storage as soon as it is imported.

Hide the Chat Header (Optional)

When your page already has its own heading, the chat's title bar repeats it. Add header to the config your component builds:

const config: WidgetEnv = {
  ...studioConfig,
  actionBar: studioConfig.actionBar && { ...studioConfig.actionBar, enabled: false },
  header: { ...studioConfig.header, hidden: true },
};

• Requires @xapp/chat-widget 1.103.0 or later.
• Applies in docked and static mode only. A floating (normal) chat always keeps its header, because that is where its minimize and close buttons are.
• If your menu button is set to appear in the header, it moves to the footer so the menu stays reachable.

Try it with the Hide header option on the Embedded Chat Examples page.

Follow the Visitor as They Scroll (Optional)

An embedded chat scrolls away with the page, so a visitor who carries on reading loses the conversation they started. popOut lets it follow them: while its place on the page is off-screen the chat moves into a floating window in the corner, and it returns when they scroll back to it.

const config: WidgetEnv = {
  ...studioConfig,
  popOut: { enabled: true },
};

It is the same chat that moves, not a second one, so the conversation carries on — including a message being typed. On a phone it offers the chat button (or the action bar) instead of a window covering the screen; tapping that opens the conversation where they left it.

Option	Default	What it does
enabled	false	Turns it on. Only for an embedded (docked) chat — a floating chat already floats.
after	"seen"	"seen" follows anyone who scrolls past. "message" waits until the visitor has sent something, so a chat nobody has spoken to stays on the page. The assistant's greeting does not count.
minWidth	640	Narrowest window that opens the floating chat. Below this, see mobile.
mobile	"auto"	What a narrow screen gets: "auto" (the action bar if the app has one, otherwise the chat button), "actionBar", "button", or "none".

• Requires @xapp/chat-widget 1.104.0 or later.
• The chat must have been on screen once before it follows anyone, so a chat below the fold never floats in front of a visitor who has not reached it yet.
• The floating window always has a header, even with header.hidden set, because that is how the visitor puts it away. Closing it returns the chat to the page — on a phone, back to the entry point — and it follows again the next time they scroll past.
• Where the visitor is reading is kept across the move: at the newest message they stay there, and reading back through the thread keeps their place.

Verify Installation

1. Open the page with the chat and confirm it shows its welcome message inside your container.
2. Navigate to another page and back without refreshing — the chat should appear again.
3. Check the browser console for errors mentioning the chat widget.

Troubleshooting

• Embedded chat is not visible: Its container has no height. Give the container a fixed or flex height.
• Two chat windows on one page: The script snippet is also installed. Don't combine the floating script snippet with an embedded chat on the same page.
• Chat opens a floating window instead of filling the container: Check that mode is "docked".