🧩 GoRouter Modular

🚀 Modular Flutter Development

Build scalable Flutter applications with dependency injection, event-driven communication, and seamless routing.

Made with contrib.rocks

---

⚡ Quick Start

📦 Install

flutter pub add go_router_modular

pubspec.yaml

dependencies:
  flutter:
    sdk: flutter
  go_router_modular: ^any

🧩 Create core files

lib/src/app_widget.dart

import 'dart:ui';
import 'package:flutter/material.dart';
import 'package:go_router_modular/go_router_modular.dart';

class AppWidget extends StatelessWidget {
  const AppWidget({super.key});

  @override
  Widget build(BuildContext context) {
    return ModularApp.router(
      title: 'Modular GoRoute Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
    );
  }
}

lib/src/app_module.dart

import 'package:go_router_modular/go_router_modular.dart';

class AppModule extends Module {
  @override
  FutureOr<List<Bind<Object>>> binds() => [
   // Bind.singleton<HomeController>((i) => HomeController()),
  ];

  @override
  List<ModularRoute> get routes => [
   // ModuleRoute('/', child: (context, state) => HomeModule()),
  ];
}

🚀 Configure App

lib/main.dart

import 'package:flutter/material.dart';
import 'package:go_router_modular/go_router_modular.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Modular.configure(
    appModule: AppModule(), 
    initialRoute: "/",
    debugLogDiagnostics: true,
    debugLogDiagnosticsGoRouter: true,
  );
  runApp(AppWidget());
}

🚀 Start Building Now!

---

✨ Why Choose GoRouter Modular?

🧩 Modular Architecture

Organize your Flutter app into independent, reusable modules with clear boundaries and responsibilities.

See Example 👆

📁 lib/src/modules/
  📁 auth/     - Authentication features
  📁 home/     - Home screen and features
  📁 profile/  - User profile management
  📁 shared/   - Common services

💉 Dependency Injection

Per-module DI with auto-dispose and lifecycle management. Easy testing with mock dependencies.

See Example 👆

// Inject dependencies
final controller = context.read<HomeController>();
final service = Modular.get<ApiService>();

// Different binding types
Bind.singleton<ApiService>((i) => ApiService()),
Bind.factory<Repository>((i) => Repository()),
Bind.lazySingleton<Database>((i) => Database()),

🛣️ GoRouter Integration

Seamless integration with declarative, type-safe navigation in your Flutter app.

See Example 👆

// Navigate between modules
context.go('/user/123');
context.push('/modal');

// With parameters
context.go('/search?q=flutter');

// Module routes
ModuleRoute('/auth', module: AuthModule()),
ModuleRoute('/user', module: UserModule()),

🎭 Event System

Event-driven communication between modules. Perfect for micro frontend architectures.

See Example 👆

// Fire events from anywhere
modularEvent.fire(UserLoggedInEvent(user: user));

// Listen in modules
on<UserLoggedInEvent>((event, context) {
  // Handle user login across modules
});

🎯 Custom Loaders

Built-in loading system with customizable indicators during module transitions.

See Example 👆

// Automatic loading during navigation
ModularLoader.show();
ModularLoader.hide();

// Custom loader design
class MyLoader extends CustomModularLoader {
  @override
  Widget get child => MySpinner();
}

⚡ Hot Reload Friendly

Fast development with instant feedback. Dependencies persist across hot reloads.

Benefits 👆

• 🔥 State preserved during development
• ⚡ Instant UI updates
• 🧪 Easy debugging and testing
• 🚀 Faster development cycle

---

🏗️ Architecture Overview

---

🎭 Perfect for Micro Frontends

🚀 Teams Working Independently

Build applications where different teams work on different features without conflicts:

🛒

Cart Team
Manages cart logic and UI

💳

Payment Team
Handles payment processing

📦

Product Team
Manages product catalog

🔔

Notification Team
Handles all notifications

All teams communicate through events without tight coupling! 🎯

---

📚 Learning Paths

🚀 I'm New to Modular

Start with our step-by-step tutorial that builds a complete app from scratch.

Getting Started Guide

💉 I Want to Learn DI

Understand dependency injection patterns and best practices.

Dependency Injection

🎭 I Need Module Communication

Learn about event-driven architecture and micro frontends.

Event System

---

💙 Community & Support

⭐

Star on GitHub
Show your support

GitHub

📦

pub.dev
Latest version

pub.dev

🐛

Report Issues
Get help & feedback

Issues

📖

Documentation
Learn & explore

Docs

---

🚀 Ready to build something amazing?

Join thousands of developers building scalable Flutter applications with GoRouter Modular

📦 Install Now

🚀 Start Tutorial