@amodalai/react 0.1.1 → 0.1.3
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 +40 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @amodalai/react
|
|
2
|
+
|
|
3
|
+
React hooks, components, and embeddable chat widget for adding Amodal agents to any web application.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @amodalai/react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick start
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { ChatWidget } from "@amodalai/react/widget";
|
|
15
|
+
import "@amodalai/react/widget/style.css";
|
|
16
|
+
|
|
17
|
+
function App() {
|
|
18
|
+
return (
|
|
19
|
+
<ChatWidget
|
|
20
|
+
endpoint="https://your-runtime.example.com"
|
|
21
|
+
tenantId="your-tenant-id"
|
|
22
|
+
/>
|
|
23
|
+
);
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## What's included
|
|
28
|
+
|
|
29
|
+
- **Chat widget** — drop-in conversational UI with SSE streaming, tool call display, and theming via CSS custom properties
|
|
30
|
+
- **React hooks** — `useChat`, `useSessionHistory`, `useWidgetEvents` for building custom chat interfaces
|
|
31
|
+
- **SSE client** — `ChatClient` for connecting to the Amodal runtime from any JavaScript environment
|
|
32
|
+
- **Widget components** — entity cards, timelines, data tables, score breakdowns, and more
|
|
33
|
+
|
|
34
|
+
## Documentation
|
|
35
|
+
|
|
36
|
+
[docs.amodalai.com](https://docs.amodalai.com)
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
[MIT](../../LICENSE)
|