@knowbl_ai/nexus-chat

Embeddable AI chat widget for Nexus AI Platform.

For full documentation, visit: https://docs.nexus.knowbl.com/

Installation

npm install @knowbl_ai/nexus-chat

Or via CDN:

<script src="https://unpkg.com/@knowbl_ai/nexus-chat"></script>

Quick Start

Script Tag (Recommended for most users)

<script
  src="https://unpkg.com/@knowbl_ai/nexus-chat"
  data-experience-id="your-experience-id"
></script>

The widget auto-initializes when loaded with the data-experience-id attribute.

ES Module

import { initWidget } from "@knowbl_ai/nexus-chat";

const widget = initWidget({
  experienceId: "your-experience-id",
  apiUrl: "https://nexus-api.knowbl.com/api/v2",
  theme: {
    primaryColor: "#007bff",
  },
});

// Widget API
widget.open();
widget.close();
widget.toggle();
widget.sendMessage("Hello!");

UMD (Browser Global)

<script src="https://unpkg.com/@knowbl_ai/nexus-chat"></script>
<script>
  const widget = window.NexusChatWidget.init({
    experienceId: "your-experience-id",
  });
</script>

Configuration

interface WidgetConfig {
  experienceId: string;
  apiUrl?: string; // Defaults to https://nexus-api.knowbl.com/api/v2
  theme?: {
    primaryColor?: string;
    fontFamily?: string;
  };
  position?: "bottom-right" | "bottom-left";
  messages?: {
    welcomeMessage?: string;
    placeholder?: string;
  };
  // See full documentation for all options
}

TypeScript Support

Full TypeScript support included. Types are automatically loaded when you import the package.

import { initWidget } from "@knowbl_ai/nexus-chat";
import type { WidgetConfig, WidgetAPI } from "@knowbl_ai/nexus-chat";

const config: WidgetConfig = {
  experienceId: "your-id",
};

const api: WidgetAPI = initWidget(config);

Documentation

For complete documentation including:

• Full configuration options
• Theming and customization
• Event handling
• Message interceptors
• Authentication

Visit: https://docs.nexus.knowbl.com/

Browser Support

• Chrome 90+
• Firefox 88+
• Safari 14+
• Edge 90+

Bundle Size

~30KB gzipped (all dependencies bundled)

License

Proprietary - see LICENSE file

Support

For support inquiries, contact: [email protected]