v0.2.0 Experimental

Ship Apps Faster
with ShellUI

A lightweight microfrontend shell framework. Build modern applications with sidebar navigation, modals, drawers, themes, and more. Framework agnostic and built for developers.

Features

Everything you need to build modern microfrontend applications. All features available in v0.2.0.

Layout Modes

Multiple layout modes: sidebar navigation, fullscreen content view, and Windows desktop mode with taskbar.

Flexible Navigation

Navigation menu with icons, grouped items, and customizable organization. Perfect for complex applications.

Flexible Link Opening

Open links in main content area, modal popups, side drawers, or external browser. Full control over navigation flow.

Side Drawer Panels

Slide-in panels from any direction: top, bottom, left, or right. Perfect for sidebars, notifications, and detail views.

Multi-language Support

Built-in support for English and French with localized interface. Easy to extend with additional languages.

Custom Themes

Light and dark mode variants with custom fonts for headings and body text. Full control over your app's appearance.

Toast Notifications

Multiple styles: success, error, warning, info, and loading states. Non-intrusive user feedback.

Alert Dialogs

Different button configurations: ok, ok/cancel, ok/cancel/secondary. Accessible and customizable.

Modal Windows

Display content overlays with full control. Perfect for forms, confirmations, and detailed views.

Settings Panel

Customize appearance, language preferences, and privacy options. User-friendly configuration interface.

Offline Support

Service worker integration for offline functionality and app updates. Works seamlessly in the background.

Cookie Consent

Cookie consent management with categorized privacy controls. GDPR-friendly and customizable.

Error Reporting

Built-in error reporting to help improve app stability. Integrates with Sentry for production monitoring.

Desktop App Support

Native desktop application support through Tauri integration. Build cross-platform desktop apps.

Responsive Design

Adapts seamlessly to mobile and desktop screens. Customizable navigation item visibility per device.

Built for Developers

Framework agnostic, TypeScript-first, and designed with developer experience in mind.

Packages

@shellui/cli

Command-line tool for creating and managing ShellUI applications. Includes scaffolding, build, and development server.

@shellui/core

Core React application runtime. Provides all UI components, layouts, themes, and functionality.

@shellui/sdk

JavaScript SDK for programmatic ShellUI integration. Perfect for advanced use cases and custom tooling.

Tech Stack

React & TypeScript

Built with React 18+ and TypeScript for type safety and modern development experience.

Radix UI & shadcn/ui

Accessible components built on Radix UI primitives, styled with Tailwind CSS following shadcn/ui patterns.

i18next

Internationalization support with i18next and react-i18next. Easy to extend with additional languages.

Quick Start

# 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 start

Ready to Build?

Start building your microfrontend application today. ShellUI v0.2.0 is experimental but ready for your projects.