Simple examples to get started with PraisonAIUI.
Each example teaches exactly one new concept — no overlap.
| # | Name | Unique Concept | Run |
|---|---|---|---|
| 01 | chat | @reply + aiui.say() — minimal hello-world | aiui run app.py |
@reply
aiui.say()
aiui run app.py
| 02 | chat-app | Full lifecycle callbacks (@welcome, @button, @profiles, @starters, @goodbye) | aiui run app.py |
@welcome
@button
@profiles
@starters
@goodbye
| 03 | chat-with-ai | OpenAI streaming via stream_token() | aiui run app.py |
stream_token()
| 04 | chat-with-praisonai | PraisonAI Agent, asyncio.to_thread(), stream=False | aiui run app.py |
asyncio.to_thread()
stream=False
| 05 | agent-playground | Multi-agent @profiles switching | aiui run app.py |
| 06 | dashboard | @page decorator, @on("event") syntax | aiui run app.py |
@page
@on("event")
| 07 | provider-praisonai | Custom BaseProvider subclass, RunEvent protocol | aiui run app.py |
BaseProvider
RunEvent
| 08 | streaming | PraisonAI Agent streaming via stream_emitter | aiui run app.py |
stream_emitter
| 09 | widget | Copilot/sidebar mode | aiui run app.py |
| 10 | feature-showcase | All protocol features seeded, create_app() | python app.py |
create_app()
python app.py
| 11 | ui-integration | Gradio ASGI mount, Streamlit iframe, REST embedding | python app.py |
| 12 | agent-dashboard | OpenClaw-style rendered HTML admin panel | python app.py |
| 13 | real-dashboard | Production dashboard with seeded data | python app.py |
| 14 | all-features | Comprehensive 16-feature API test suite | python app.py |
| 15 | dashboard-test | Dashboard component rendering tests | aiui run app.py |
| 16 | gateway-integration | Gateway WebSocket integration | aiui run app.py |
| 17 | three-column-demo | Three-column layout with sidebar + TOC | aiui run app.py |
| 18 | full-chat | Full-featured chat with all options enabled | aiui run app.py |
| 19 | components-showcase | All 48 UI components demonstrated | aiui run app.py |
| 20 | email-channel | Email channel integration | aiui run app.py |
| 21 | agentmail-bot | Agentmail bot integration | aiui run app.py |
| 22 | agentmail-channel | Agentmail channel setup | aiui run app.py |
| 23 | e2e-components-test | End-to-end component testing | aiui run app.py |
| 24 | custom-design | Custom CSS design system with set_custom_css() | aiui run app.py |
set_custom_css()
| 25 | clean-chat | Clean chat UI — sidebar=False, page_header=False, blue theme | aiui run app.py |
sidebar=False
page_header=False
| 26 | custom-theme-chat | Custom theme registration via register_theme() | aiui run app.py |
register_theme()
| 27 | multica-style | Floating chat window, collapsible sidebar, indigo theme | aiui run app.py |
The simplest configuration:
Add branding: