Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

@smooai/chat-widget — Embeddable AI chat as a web component

npmSmoo AIlicense

bundle sizeCI

Features · Install · Usage · Theming · Platform


A self-contained, streaming chat surface you drop into any site with one tag. No React on the host page, no CSS to import, ~19 kB gzipped, with the smooth-operator protocol client built in.

<smooth-agent-chat> is a self-contained chat web component for the smooth-operator protocol. Drop in one <script> tag (or import the ESM module) and you get a polished, streaming, shadow-DOM-isolated chat experience — the "Aurora Glass" design — that adapts to any host brand from a single accent color.

No React on the host page. No CSS to import. ~19 kB gzipped, protocol client included.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws" agent-id="" agent-name="Support"></smooth-agent-chat>

Live demo: open index.html (it runs entirely in the browser against an in-page mock of the protocol — no backend needed).

Why this widget

  • Aurora Glass design — a spring launcher with a live presence pulse, a glass-depth panel, gradient brand avatar + status dot, an animated typing indicator, message rise-in, refined source cards, and an icon composer.
  • Brand-adaptive — pass one primary color and the gradients, bubbles, glow, and depth shades derive themselves. Works light or dark.
  • Streaming + sources — token-by-token replies with a typing indicator and a collapsible "Sources" disclosure for knowledge-grounded answers.
  • Popover or full-page — a floating launcher, or a full-bleed /chat surface. Same component, one attribute.
  • Framework-light & isolated — a standard custom element with Shadow-DOM style isolation. Use it with React, Vue, Svelte, Astro, or no framework at all.
  • Secure by construction — message + citation text is rendered via textContent, and citation links are restricted to http(s) (no javascript:/data: XSS).

Install

pnpm add @smooai/chat-widget
# or: npm i @smooai/chat-widget · yarn add @smooai/chat-widget

@smooai/smooth-operator (the protocol client) is a runtime dependency and is installed automatically.

Quick start

1. Recommended — the deferred loader (best Core Web Vitals)

Include the tiny loader (~2 KB gzipped) eagerly. It does nothing expensive on load — it waits until the page is past its critical render (requestIdleCallback after load, or the visitor's first pointer/keydown/scroll, or an 8 s fallback), and only then injects the full widget module. The widget never competes with your page's LCP/TBT, but it's instantly there the moment a visitor shows intent.

<script>window.SmoothAgentChatConfig={endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',greeting: 'Hi! How can I help?',};</script><scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget-loader.global.js" async></script>

The loader resolves the widget module as a sibling of its own URL (override with data-src), so a single CDN path is all you need. For the simplest installs you can skip the config global and use data-* attributes on the loader tag (data-endpoint, data-agent-id, data-primary, data-mode).

2. Declarative — eager <script> + the element

Simplest, but the module evaluates during page load — prefer the loader above on performance-sensitive (especially marketing) pages.

<scriptsrc="https://unpkg.com/@smooai/chat-widget/dist/chat-widget.global.js"></script><smooth-agent-chatendpoint="wss://your-host/ws"
agent-id="11111111-1111-4111-8111-111111111111"
agent-name="Support"
greeting="Hi! How can I help?"
></smooth-agent-chat>

The IIFE bundle auto-registers the element on load.

3. Programmatic — bundler / ESM

import{mountChatWidget}from'@smooai/chat-widget';constwidget=mountChatWidget({endpoint: 'wss://your-host/ws',agentId: '11111111-1111-4111-8111-111111111111',agentName: 'Support',theme: {primary: '#8b5cf6'},});// Drive it imperatively:widget.openChat();widget.closeChat();

Or register the element and place it yourself:

import{defineChatWidget}from'@smooai/chat-widget';defineChatWidget();// now <smooth-agent-chat> works anywhere in your markup

Theming

Every color is a CSS custom property under the hood, so the simplest possible theme is a single primary — the launcher gradient, send button, user bubbles, ambient glow, and derived depth shades all follow from it.

mountChatWidget({
endpoint, agentId,theme: {primary: '#ff5d6e',// the one color most brands need to setbackground: '#ffffff',// light paneltext: '#1f2430',},});
TokenDrivesDefault
primaryLauncher, send button, user bubble, glow, avatar#00a6a6
primaryTextText/icon on top of primary#f8fafc
backgroundPanel background#040d30
textForeground text + derived inset surfaces#f8fafc
assistantBubbleInbound (assistant) bubble background#06134b
assistantBubbleTextInbound bubble text#f8fafc
userBubbleOutbound (user) bubble backgroundprimary
userBubbleTextOutbound bubble textprimaryText
borderPanel + input hairlinergba(255,255,255,.1)

Two further tokens — a darker primary-2 (gradient depth) and a surface-2 inset wash — are derived in CSS from primary/text, so you never have to supply them and they adapt automatically to light or dark themes.

Dashboard parity: the theme also accepts the SmooAI agent dashboard's 10-color model — secondary plus chatBubbleInbound / chatBubbleInboundText / chatBubbleOutbound / chatBubbleOutboundText (aliases that win over the canonical keys) — so a config exported from the dashboard themes the widget directly.

Visitor identity & starter prompts

mountChatWidget({
endpoint, agentId,examplePrompts: ['How do I get started?','Do you integrate with HubSpot?'],requireName: true,requireEmail: true,// gate the chat behind a pre-chat form…// allowAnonymous: true, // …or let visitors skip it entirely});
  • examplePrompts render as clickable chips in the empty state (max 5).
  • showSuggestedReplies (default true) shows mid-conversation suggested-reply chips under the latest assistant message when the agent returns follow-up suggestions; tapping one sends it. Set false to hide them.
  • requireName / requireEmail / requirePhone show a styled pre-chat form; the collected name/email are attached to the conversation session (phone rides session metadata). Set allowAnonymous: true to skip the form.

OTP & tool confirmation (HITL)

When a turn pauses for OTP verification or a tool-write approval, the widget shows an inline overlay above the composer — an OTP code prompt (with masked destination + retry state) or an Approve/Decline confirmation — and resumes the turn automatically. Under the hood the ConversationController surfaces otp_verification_required / write_confirmation_required via an onInterrupt callback and resumes with verifyOtp(code) / confirmTool(approved), so you can also drive it programmatically.

Full-page mode

Render the chat as a full-bleed surface (a /chat route, a docs sidebar, an iframe) instead of a floating launcher:

<smooth-agent-chatmode="fullpage" endpoint="wss://…/ws" agent-id=""></smooth-agent-chat>
import{mountFullPageChat}from'@smooai/chat-widget';mountFullPageChat({ endpoint, agentId,agentName: 'Support'},document.getElementById('chat'));

Configuration

Declarative attributes mirror the programmatic ChatWidgetConfig:

AttributeConfig keyNotes
endpointendpointRequired. smooth-operator WebSocket URL.
agent-idagentIdRequired. UUID of the agent.
agent-nameagentNameHeader label + monogram. Default Assistant.
logo-urllogoUrlBrand logo in the full-page header tile (http(s) only). Falls back to the Smooth icon.
placeholderplaceholderComposer placeholder.
greetinggreetingShown before the first message.
modemodepopover (default) or fullpage.
start-openstartOpenOpen the panel immediately (no launcher click).
hide-brandinghideBrandingHide the "powered by smooth-operator" tag + footer link. Default shown.
show-tool-activityshowToolActivityShow the agent's tool activity as inline chips interleaved with its prose. Default off (end-users normally shouldn't see raw tool calls).
themeBrand colors (see Theming).
userName / userEmailOptional participant identity.

Programmatic API

mountChatWidget(config, target?) and mountFullPageChat(config, target?) return the element, which exposes:

  • configure(partialConfig) — merge overrides (e.g. live theme tweaks) and re-render.
  • openChat() / closeChat() — toggle the popover panel.

How it works

The widget is pure view + a thin ConversationController that speaks the smooth-operator protocol via @smooai/smooth-operator:

connect() → WebSocket + create_conversation_session
send(text) → send_message → stream_token … (live) … → eventual_response (+ citations)

The wire protocol is owned by smooth-operator; this package only renders it. That keeps one source of truth for the protocol and lets the widget stay tiny.

Browser support

Evergreen browsers (Chrome/Edge 111+, Safari 16.4+, Firefox 113+). The design uses color-mix() to derive brand shades and ::part() for host-side customization.

Local development

pnpm install
pnpm build # tsdown → dist/ (ESM + IIFE)
pnpm typecheck # tsc --noEmit
pnpm test# vitest (jsdom) unit + render smoke tests
pnpm check # typecheck + test + build
pnpm test:e2e # Playwright live e2e (gated — see e2e/)

Open index.html (e.g. pnpm dlx serve .) after a build for the interactive, backend-free showcase.

Part of Smoo AI

@smooai/chat-widget is built and open-sourced by Smoo AI — the AI-powered business platform with AI built into every product: CRM, customer support, campaigns, field service, observability, and developer tools.

Contributing

Issues and PRs welcome. Run pnpm check (typecheck + test + build) before opening a PR.

License

MIT © Smoo AI


Built by Smoo AI — AI built into every product.

About

Embeddable chat widget for smooth-operator — a web component that speaks the schema-driven WebSocket protocol. Built with tsdown, dogfooded into Smoo AI.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages