Package Exports
- @xenara/xena-sdk
- @xenara/xena-sdk/dist/widget.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@xenara/xena-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
๐ง Xena SDK โ Embed AI Agents into Any Web Platform
Xena SDK is a powerful, plug-and-play SDK that lets you embed conversational AI agents into any website or web application in minutes. Enable intelligent conversations, automate workflows, and enhance user engagement with ease.
๐ Features
- โก๏ธ Lightweight & Fast โ Designed for quick embedding with minimal setup.
- ๐ง AI-Powered โ Backed by powerful LLMs for human-like conversation.
- ๐จ Customizable UI โ Change colors, avatars, and prompts to match your brand.
- ๐ Platform Agnostic โ Works on any frontend (React, Vue, Angular, or plain HTML).
- ๐ Secure & Scalable โ Optimized for production deployments.
- ๐ช Event Hooks & API Integration โ Easily connect to your internal tools or APIs.
- ๐ฆ CDN or NPM Ready โ Load via script tag or install via npm.
๐ฆ Installation
Option 1: Using npm/yarn
npm install xena-sdk
# or
yarn add xena-sdk
Option 2: Using CDN
<script src="https://cdn.jsdelivr.net/npm/xena-sdk@latest/dist/xena.min.js"></script>
๐ ๏ธ Usage
Basic Setup (with npm)
import { XenaAgent } from 'xena-sdk';
XenaAgent.init({
agentId: 'your-agent-id',
theme: {
primaryColor: '#4F46E5',
avatarUrl: 'https://yourcdn.com/avatar.png'
},
containerId: 'xena-container' // Optional: your custom container div
});
HTML Example (via CDN)
<div id="xena-container"></div>
<script src="https://cdn.jsdelivr.net/npm/xena-sdk@latest/dist/xena.min.js"></script>
<script>
XenaAgent.init({
agentId: 'your-agent-id',
theme: {
primaryColor: '#00A67E'
}
});
</script>
๐จ Customization
You can pass the following options to init()
:
Option | Type | Description |
---|---|---|
agentId |
string |
Unique identifier for your AI agent |
theme |
object |
Colors, avatars, fonts, etc. |
containerId |
string |
DOM ID to mount the chat widget |
language |
string |
Language for interface & assistant |
welcomeText |
string |
Initial greeting message |
hooks |
object |
Event listeners (e.g., onMessageSent ) |
๐ Integrations
Xena SDK can be integrated with:
- ๐ Your internal APIs (e.g., for FAQs, user data, transactions)
- ๐ฌ Backend chat engines or ML endpoints
- ๐ Analytics tools like Google Analytics or Mixpanel
๐งช Example Projects
Demo | Tech Stack |
---|---|
Basic HTML | HTML + JS |
React App | React + Vite |
Vue Example | Vue 3 |
๐งฉ Future Roadmap
- Voice input/output
- Multi-agent support
- Chat memory and history sync
- Plugin system for adding skills
- Mobile SDKs
๐ค Contributing
We welcome contributions! Please read our contribution guide before submitting a pull request.
๐ License
This project is licensed under the MIT License.