ShellUI Documentation
Welcome to the ShellUI documentation!
ShellUI is a lightweight microfrontend shell to ship apps faster.
Getting Started
New to ShellUI? Follow these steps to get up and running:
- Installation - Install ShellUI CLI and dependencies
- Quick Start - Create your first ShellUI app in minutes
Core Features
Navigation & Layout
- Navigation - Build flexible navigation menus with icons, groups, and multiple display modes
- Layouts - Choose from sidebar, fullscreen, windows desktop (experimental), or app bar layouts
- Modals & Drawers - Open content in modal overlays or side drawer panels
Customization
- Themes - Create custom themes with light/dark modes, custom fonts, and colors
- Internationalization - Multi-language support with localized navigation and UI
User Interface
- Toast Notifications - Show toast notifications with multiple styles and actions
- Alert Dialogs - Display alert dialogs with different button configurations
Advanced Features
- Application Settings - Expose per-application settings panels in Settings
- Cookie Consent - Privacy-friendly cookie consent management
- Service Worker - Offline support and automatic app updates
- SDK Integration - Programmatically integrate ShellUI features in your apps
Reference
- CLI Reference - Command-line tool commands and options
- Core Package - Core React application runtime
- SDK Reference - JavaScript SDK API documentation
- Tauri Integration - Build desktop apps with Tauri
Developer Resources
- Development Guide - Contributing to ShellUI
- Publishing Guide - Publishing ShellUI packages