Documentation

Master the art of modular Flutter architecture with Mosaic

Welcome to Mosaic

Mosaic is a powerful, modular Flutter architecture that enables clean separation of features using dynamic modules, internal event systems, UI injection, and centralized build orchestration.

๐Ÿงฉ
Modular
Independent modules
โšก
Event-Driven
Decoupled communication
๐ŸŽฏ
Type-Safe
Strongly typed events
๐Ÿงช
Testable
Built for testing
## What makes Mosaic special? Mosaic helps large applications scale with ease by treating each feature as an **isolated unit** that can be enabled, built, and tested independently. Think of it as building with LEGO blocks - each piece fits perfectly together, but can work on its own. ### Core Features - **๐Ÿงฉ Modular Architecture**: Organize your app into independent, reusable modules - **โšก Event-Driven Communication**: Decoupled communication between modules using a robust event system - **๐ŸŽฏ Dynamic UI Injection**: Inject UI components dynamically across different modules - **๐Ÿงญ Internal Navigation**: Module-specific routing with stack management - **๐Ÿ“Š Advanced Logging**: Multi-dispatcher logging system with file and console output - **๐Ÿ”’ Thread Safety**: Built-in mutex and semaphore utilities for concurrent operations - **๐Ÿ”„ Auto Queue**: Automatic retry mechanism for async operations - **โœ… Type-Safe Events**: Strongly typed event system with wildcard support ## Architecture Overview Mosaic follows a modular architecture pattern where each feature is encapsulated in its own module. Here's how it works:
Module A Home, Dashboard Module B Profile, Settings Module C Chat, Messages Event System Router โ€ข Events โ€ข Injector โ€ข Logger
Each module can communicate with others through the centralized event system, inject UI components into other modules, and maintain its own internal navigation stack. ## Quick Installation Get started with Mosaic in just a few minutes: ```yaml dependencies: flutter: sdk: flutter mosaic: ^0.0.1 ``` ```bash flutter pub get ``` ## Next Steps Ready to dive deeper? Here's where to go next: ## Community & Support Join our growing community of developers who are building amazing things with Mosaic: - **๐Ÿ“– Documentation**: Complete guides and API reference - **๐Ÿ’ฌ Discord**: Get help and share your projects - **๐Ÿ› GitHub Issues**: Report bugs and request features - **๐ŸŽฏ Discussions**: Share ideas and best practices --- **Ready to build something amazing?** [Get started with the installation guide โ†’](/docs/installation)