Introduction
Welcome to BotUI documentation 👋🏼
BotUI makes it super easy to create conversational (bot) interfaces. It has an intuitive JavaScript API to add messages and show actions that a user can perform. It has a React package but Vue and other frameworks are also supported (you can easily integrate it into your [insert-any-framework-name-here] project).
Quick Start
- Install BotUI - Get up and running in minutes
- Core Concepts - Understand BotUI's architecture
Core Documentation
Core Package (botui)
- API Reference - Complete API documentation
- Plugins Guide - Learn how to extend BotUI with plugins
React Package (@botui/react)
- API Reference - React components and hooks
- Custom Components - Build custom actions and messages
- Built-in Messages - Available message types
- Built-in Actions - Available action types
- Styling Guide - Theming and customization
- TypeScript Guide - React + TypeScript integration
Advanced Topics
- Core TypeScript - Framework-agnostic TypeScript usage
- Advanced Examples - Real-world usage patterns
- Error Handling - Debugging and error recovery
- Common Issues - Known issues and solutions
Quick Links
🚀 Quickstart Repo - Get started immediately 💬 Discussions - Ask questions and share ideas 🐛 Issues - Report bugs and request features ⭐ Showcase - See what others are building