@supportai.it/chat-widget/README.md

Chat widget web component for supportAI.it

# Universal Chat Widget

[![](https://data.jsdelivr.com/v1/package/npm/@supportai.it/chat-widget/badge)](https://www.jsdelivr.com/package/npm/@supportai.it/chat-widget)

## Installation

### Usign CND:

```html
<script src="https://cdn.jsdelivr.net/npm/@supportai.it/chat-widget"></script>
```

### Using npm

```bash
npm install @supportai.it/chat-widget
```

## Usage

### JS

```html
<chat-widget
  chat-id="chat-id"
  api-key="api-key"
  button-color="#ff0000"
  button-size="56px"
></chat-widget>

<script>
  // Example of dynamic context update
  window.addEventListener("DOMContentLoaded", () => {
    const widget = document.querySelector("chat-widget");

    if (widget) {
      widget.getContext = () => {
        return JSON.stringify({ user: "example" });
      };
    }
  });
</script>
```

### React

```jsx
import { useEffect, useRef } from "react";
import "@supportai.it/chat-widget";

function App() {
  const chatRef = useRef(null);

  useEffect(() => {
    // Example of dynamic context update
    const getContext = () => {
      return JSON.stringify({ user: "example" });
    };

    if (chatRef.current) {
      chatRef.current.getContext = getContext;
    }
  }, []);

  return (
    <chat-widget
      ref={chatRef}
      chat-id="chat-id"
      api-key="api-key"
    ></chat-widget>
  );
}
```

### Vue
```vue
<script setup>
  import { useTemplateRef, onMounted } from 'vue'
  import '@supportai.it/chat-widget'

  const chatWidget = useTemplateRef("chatWidget")

  onMounted(() => {
    if (chatWidget.value) {
      chatWidget.value.getContext = () => {
        return JSON.stringify({ user: "example" })
      }
    }
  })
</script>

<template>
    <chat-widget
      ref="chatWidget"
      chat-id="chat-id"
      api-key="api-key"
    ></chat-widget>
</template>
```

### Updating Context Dynamically

```javascript
// Dispatch event to update context
window.dispatchEvent(new CustomEvent("chat-widget/updateContext"));
```

## Props

- `chat-id`: The ID of the chat to be opened.
- `api-key`: The API key for authentication.
- `button-color`: Custom button color (Default: #582975)
- `button-hover-color`: Custom hover color (Default: #7b2ba6)
- `button-size`: Button size (Default: 64px)
- `message-bubble`: Display a message bubble on top of the open button (when the chat is closed). Set to `false` to disable.
- `chat-align`: Chat alignment "left" or "right". (Default: right)