Nexia Bot Core

A core library that provides functionalities to integrate with the Nexia Bot Framework Web Chat. This library is designed for seamless integration with vanilla JavaScript applications.

Table of Contents

• Installation
• Usage
• API Reference
• Style Options
• Contributing
• License

Installation

To install the core library, you can either download the library files directly or use a package manager like npm.

Using npm

npm install @nexia/bot-core

Usage

Here's a quick example of how to use the library:

import { initializeWebChat, loadBotFrameworkWebChat } from "@nexia/bot-core";

// Load the Bot Framework Web Chat script
loadBotFrameworkWebChat()
  .then(() => {
    // Initialize Web Chat
    const directLineToken = "YOUR_DIRECT_LINE_TOKEN";
    const element = document.getElementById("webchat");
    initializeWebChat(element, directLineToken);
  })
  .catch((error) => {
    console.error("Failed to load WebChat:", error);
  });

API Reference

loadBotFrameworkWebChat()

Loads the Bot Framework Web Chat script.

Returns: Promise<void>

initializeWebChat(element: HTMLElement, directLineToken: string)

Initializes the Web Chat within the specified HTML element.

Parameters:

• element - The HTML element where the Web Chat will be rendered.
• directLineToken - Your Direct Line token for authentication.

Returns: Promise<void>

Style Options

You can customize the appearance of the Web Chat using the styleOptions parameter. Here are the available options:

type StyleOptions = {
  accent?: string;
  backgroundColor?: string;
  subtle?: string;
  paddingRegular?: number;
  paddingWide?: number;
  bubbleBackground?: string;
  bubbleBorderColor?: string;
  bubbleTextColor?: string;
  // Add more options as needed
};

Contributing

By participating in this project, you agree to abide by our code of conduct.

License

See the LICENSE file for details.