A lightweight microfrontend shell framework. Build modern applications with authentication, legal documents, sidebar navigation, modals, drawers, themes, and more. Connect the identity-service backend or embed an admin panel in your app. Framework agnostic and built for developers.
Everything you need to build modern microfrontend applications. New in v0.3.0: authentication, legal documents, the identity-service backend, and optional in-app admin panels.
Multiple layout modes: sidebar navigation, fullscreen content view, and Windows desktop mode with taskbar.
Navigation menu with icons, grouped items, and customizable organization. Perfect for complex applications.
Open links in main content area, modal popups, side drawers, or external browser. Full control over navigation flow.
Slide-in panels from any direction: top, bottom, left, or right. Perfect for sidebars, notifications, and detail views.
Built-in support for English and French with localized interface. Easy to extend with additional languages.
Light and dark mode variants with custom fonts for headings and body text. Full control over your app's appearance.
Multiple styles: success, error, warning, info, and loading states. Non-intrusive user feedback.
Different button configurations: ok, ok/cancel, ok/cancel/secondary. Accessible and customizable.
Display content overlays with full control. Perfect for forms, confirmations, and detailed views.
Customize appearance, language preferences, and privacy options. User-friendly configuration interface.
Service worker integration for offline functionality and app updates. Works seamlessly in the background.
Cookie consent management with categorized privacy controls. GDPR-friendly and customizable.
Built-in error reporting to help improve app stability. Integrates with Sentry for production monitoring.
Sign-in flows with Supabase or ShellUI auth, route-aware login, and redirect support for protected pages.
Ship privacy policy, terms of service, legal notice, and data processing agreement content from markdown in your shell config.
Pair ShellUI with the new identity-service Django backend for OAuth login, JWT sessions, and user metadata.
Optionally embed an admin panel inside your shell for staff users, user management, metrics, and OAuth app configuration.
Native desktop application support through Tauri integration. Build cross-platform desktop apps.
Adapts seamlessly to mobile and desktop screens. Customizable navigation item visibility per device.
Framework agnostic, TypeScript-first, and designed with developer experience in mind.
Command-line tool for creating and managing ShellUI applications. Includes scaffolding, build, and development server.
Core React application runtime. Provides all UI components, layouts, themes, and functionality.
JavaScript SDK for programmatic ShellUI integration. Perfect for advanced use cases and custom tooling.
Built with React 18+ and TypeScript for type safety and modern development experience.
Accessible components built on Radix UI primitives, styled with Tailwind CSS following shadcn/ui patterns.
Internationalization support with i18next and react-i18next. Easy to extend with additional languages.
# Create project directory
mkdir my-shellui-app
cd my-shellui-app
# Initialize npm project
npm init -y
# Install ShellUI dependencies
npm install --save-dev @shellui/cli @shellui/core
# Create shellui.config.ts
# (See docs for configuration options)
# Start development server
shellui startStart building your microfrontend application today. ShellUI v0.3.0 adds authentication, legal documents, and optional admin tooling while staying experimental and ready for your projects.