Guide
Welcome to the Modularity documentation.
Basics
- Getting Started — Install, create a module, wire the app
- Module Architecture — Visibility, imports, parent scope, expects
Core Concepts
- Module Retention — strict, routeBound, keepAlive policies
- Hot Reload — How hot reload preserves module state
- Dependency Overrides — Replace bindings for testing and feature flags
Integrations
- Injectable Integration — Bridge to injectable/get_it
- Routing Integration — GoRouter, AutoRoute, tab navigation
- State Management — Bloc, Riverpod, MobX patterns
Tools & Practices
- Testing Modules — Unit tests, widget tests, mocking
- CLI Tools — Module graph analysis and visualization
- Best Practices — Patterns, anti-patterns, checklists
Packages
| Package | Description |
|---|---|
| modularity_contracts | Core interfaces and abstractions (Binder, Module, ExportableBinder) |
| modularity_core | SimpleBinder, ModuleController, GraphResolver |
| modularity_flutter | Flutter widgets: ModuleScope, ModularityRoot, ModuleProvider |
| modularity_cli | CLI tools for module graph analysis and visualization |
| modularity_injectable | Integration bridge to injectable/get_it |
| modularity_get_it | Standalone GetIt adapter for Modularity |