@airyhq/chat-plugin
TypeScript icon, indicating that this package has built-in type declarations

0.43.0 • Public • Published

Airy Chat Plugin

Airy Chat Plugin is an open-source chat widget that is fully customizable and included in Airy Core.

Install

npm install --save @airyhq/chat-plugin

or

yarn add @airyhq/chat-plugin

Usage

First, set up the Airy Chat Plugin as a source to Airy Core to get the channelId. Then, install the package and import the Airy Chat Plugin to a React component. Pass the configuration variables to the AiryChatPlugin wrapper to customize it.

import React from "react";
import {AiryChatPlugin, AiryChatPluginConfiguration} from "@airyhq/chat-plugin";

const Component = () => {
  const config: AiryChatPluginConfiguration = {
    apiHost: ApiHostURL,
    channelId: yourChannelId,
    config: {
      showMode: true,
      headerText: "i am a header text",
      startNewConversationTex: "start new conversation text",
      headerTextColor: "#FF0000",
      primaryColor: "#0000FF",
      accentColor: "#FFA500",
      backgroundColor: "#8510d8",
      bubbleIconUrl: "#FFFF00",
      sendMessageIcon: "https://yourcustomIcon/sent.png"
    }
  };

  return (
    <div className="demoChatPlugin">
      <AiryChatPlugin config={config} />
    </div>
  );
};

License

Apache 2.0 © Airy, Inc.

Readme

Keywords

none

Package Sidebar

Install

npm i @airyhq/chat-plugin

Weekly Downloads

1

Version

0.43.0

License

Apache-2.0

Unpacked Size

910 kB

Total Files

65

Last publish

Collaborators

  • engineering-airy
  • cptchrismatic
  • aalgorta
  • steffh
  • audreykadjar