Flutter App : A package to speed up the creation of micro frontend(or independent features) structure in Flutter applications

NavigatorInstance.pop();
NavigatorInstance.pushNamed();
NavigatorInstance.pushNamedNative();
NavigatorInstance.pushReplacementNamed();
NavigatorInstance ...

// If not implemented, always return null final isValidEmail = await NavigatorInstance.pushNamedNative<bool>( 'emailValidator', arguments: 'validateEmail:lorem@ipsum.com' ); print('Email is valid: $isValidEmail');

// Listen to all flutter navigation events NavigatorInstance.eventController.flutterLoggerStream.listen((event) { logger.d('[flutter: navigation_log] -> $event'); }); // Listen to all native (Android/iOS) navigation events (if implemented) NavigatorInstance.eventController.nativeLoggerStream.listen((event) {}); // Listen to all native (Android/iOS) navigation requests (if implemented) NavigatorInstance.eventController.nativeCommandStream.listen((event) {});

  MicroAppPreferences.update(
    MicroAppConfig(
      nativeEventsEnabled: true, // If you want to dispatch and listen to events between native(Android/iOS) [default = false]
      pathSeparator: MicroAppPathSeparator.slash // It joins the routes segments using slash "/" automatically
    )
  );

// Export all routes class Application1Routes extends MicroAppRoutes { @override MicroAppBaseRoute get baseRoute => MicroAppBaseRoute('application1'); String get page1 => baseRoute.path('page1'); String get page2 => baseRoute.path('page2', ['segment1', 'segment2']); }

NavigatorInstance.pushNamed(OtherMicroAppRoutes().specificPage);
NavigatorInstance.pushNamed(Application1Routes().page1);

import 'package:micro_routes/exports.dart'; class Application1MicroApp extends MicroApp with Application1Routes { @override List<MicroAppPage> get pages => [ MicroAppPage(name: baseRoute.name, builder: (context, arguments) => const Initial()), MicroAppPage(name: page1, builder: (context, arguments) => const Page1()), MicroAppPage(name: page2, builder: (context, arguments) { final page2Params.fromMap(arguments); return Page2(params: page2Params); }), ]; }

void main() { runApp(MyApp()); } class MyApp extends MicroHostStatelessWidget { @override Widget build(BuildContext context) { return MaterialApp( title: 'Flutter Demo', navigatorKey: NavigatorInstance.navigatorKey, // Required onGenerateRoute: onGenerateRoute, // [onGenerateRoute] this is created automatically, so just use it, or override it, if needed. initialRoute: baseRoute.name, navigatorObservers: [ NavigatorInstance // Add NavigatorInstance here, if you want to get didPop, didReplace and didPush events ], ); } // Base route of host application @override MicroAppBaseRoute get baseRoute => MicroAppBaseRoute('/'); // Register all root [MicroAppPage]s here @override List<MicroAppPage> get pages => [ MicroAppPage(name: baseRoute.name, builder: (_, __) => const HostHomePage()) ]; // Register all [MicroApp]s here @override List<MicroApp> get microApps => [MicroApplication1(), MicroApplication2()]; }

// dispatching in channel "user_auth", only
MicroAppEventController()
    .emit(const MicroAppEvent(
        name: 'my_event',
        payload: {'data': 'lorem ipsum'},
        channels: ['user_auth'])
    );

// It listen to all events @override MicroAppEventHandler? get microAppEventHandler => MicroAppEventHandler((event) => logger.d([ event.name, event.payload])); // It listen to events with id equals 123, only! @override MicroAppEventHandler? get microAppEventHandler => MicroAppEventHandler((event) { logger.d([ event.name, event.payload]); }, id: '123'); // It listen to events with channels "chatbot" and "user_auth" @override MicroAppEventHandler? get microAppEventHandler => MicroAppEventHandler((event) { // User auth feature, asked to show a popup :) myController.showDialog(event.payload); }, channels: ['chatbot', 'user_auth']);

MicroAppEventController().unregisterHandler(id: '123');
MicroAppEventController().unregisterHandler(channels: ['user_auth']);
MicroAppEventController().pauseAllHandlers();
MicroAppEventController().resumeAllHandlers();
MicroAppEventController().unregisterAllHandlers();

final subscription = MicroAppEventController().stream.listen((MicroAppEvent event) {
    logger.d(event);
  });

// later, in dispose method of the widget
@override
void dispose() {
    subscription.cancel();
    super.dispose();
}

MicroAppEventController().registerHandler(MicroAppEventHandler(id: '1234'));

// later, in dispose method of the widget
@override
void dispose() {
    MicroAppEventController().unregisterSubscription(id: '1234');
    super.dispose();
}

  @override
  Route? onGenerateRoute(RouteSettings settings, {bool? routeNativeOnError}) {
    //! If you wish native app receive requests to open routes, IN CASE there
    //! is no route registered in Flutter, please set [routeNativeOnError: true]
    return super.onGenerateRoute(settings, routeNativeOnError: true);
  }

@override Route? onGenerateRoute(RouteSettings settings, {bool? routeNativeOnError}) { final pageRoute = super.onGenerateRoute(settings, routeNativeOnError: false); if (pageRoute == null) { // If pageRoute is null, this route wasn't registered(unavailable) return MaterialPageRoute( builder: (_) => Scaffold( appBar: AppBar(), body: const Center( child: Text('Page Not Found'), ), )); } return pageRoute; }