@kivox/widget 0.1.0-beta.5 → 0.1.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# KIVOX Widget
|
|
2
2
|
|
|
3
|
-
`@kivox/widget` is the official embeddable web widget for interacting with KIVOX. It provides a ready-to-use chat and voice interface that can be embedded into any website or web application with minimal setup. The widget is built on top of
|
|
3
|
+
`@kivox/widget` is the official embeddable web widget for interacting with KIVOX. It provides a ready-to-use chat and voice interface that can be embedded into any website or web application with minimal setup. The widget is built on top of [@kivox/client](https://github.com/ekisa-team/kivox/tree/main/packages/kivox-client) and handles UI, audio I/O, session lifecycle, and real-time events automatically.
|
|
4
4
|
|
|
5
5
|
Features
|
|
6
6
|
|
|
@@ -34,7 +34,7 @@ bun add @kivox/widget
|
|
|
34
34
|
|
|
35
35
|
## Installation (CDN)
|
|
36
36
|
|
|
37
|
-
The widget can also be loaded directly from a CDN without a build step. This is the easiest way to embed
|
|
37
|
+
The widget can also be loaded directly from a CDN without a build step. This is the easiest way to embed KIVOX into static sites or server-rendered pages.
|
|
38
38
|
|
|
39
39
|
```html
|
|
40
40
|
<script type="module">
|
|
@@ -68,7 +68,7 @@ Then use the custom element:
|
|
|
68
68
|
<html lang="en">
|
|
69
69
|
<head>
|
|
70
70
|
<meta charset="utf-8" />
|
|
71
|
-
<title>
|
|
71
|
+
<title>KIVOX Widget</title>
|
|
72
72
|
<script type="module">
|
|
73
73
|
import '@kivox/widget';
|
|
74
74
|
</script>
|
|
@@ -120,7 +120,7 @@ document.body.appendChild(widget);
|
|
|
120
120
|
| Name | Type | Description |
|
|
121
121
|
| ---------- | ------------------------ | ----------------------------- |
|
|
122
122
|
| `agent-id` | `string` | ID of the agent to connect to |
|
|
123
|
-
| `base-url` | `string` | Base URL of the
|
|
123
|
+
| `base-url` | `string` | Base URL of the KIVOX API |
|
|
124
124
|
| `mode` | `"chat" \| "voice"` | Conversation mode |
|
|
125
125
|
| `theme` | `"light" \| "dark"` | Widget theme |
|
|
126
126
|
| `headers` | `Record<string, string>` | Additional HTTP headers |
|
|
@@ -143,9 +143,9 @@ widget.addEventListener('kivox:error', (e: any) => {
|
|
|
143
143
|
});
|
|
144
144
|
```
|
|
145
145
|
|
|
146
|
-
## Relationship to the
|
|
146
|
+
## Relationship to the KIVOX Client
|
|
147
147
|
|
|
148
|
-
The widget is built on top of the official
|
|
148
|
+
The widget is built on top of the official KIVOX client:
|
|
149
149
|
|
|
150
150
|
- `@kivox/client` handles protocol, sessions, events, and audio primitives
|
|
151
151
|
- `@kivox/widget` adds UI, theming, and interaction layers
|