event_cascade

A top‑down, most‑recently‑active‑first event dispatch framework for Flutter. Supports multiple event types, works with Navigator routes, custom TabControllers, or any context‑based UI (tabs, drawers, etc.).

---

🌟 Features

• Hierarchical dispatch: events propagate from the most recently visible page down to older ones
• Typed handlers: strongly‑typed CascadeEventHandler<T> avoids runtime casts
• Global dispatch: call PageCascadeNotifier.dispatch(event) anywhere
• Route & Tab support: automatically tracks route pushes/pops and tab selection
• No static keys: uses each wrapper’s BuildContext as the unique identifier

---

📦 Installation

Add to your pubspec.yaml:

dependencies:
  event_cascade: ^0.1.0

Then run:

flutter pub get

---

🚀 Quick Start

1. Import the package:

   import 'package:event_cascade/event_cascade.dart';
   

2. Wrap each “page” (route or tab) in a PageCascadeNotifier, supplying any handlers:

   class MyPage extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return PageCascadeNotifier(
         handlers: [
           // Async handler
           CascadeEventHandler<MyEvent>(
             (e) async {
               // handle event e asynchronously
               await Future.delayed(Duration(milliseconds: 100));
               return true; // consume to stop propagation
             }
           ),
           // Synchronous handler using .sync constructor
           CascadeEventHandler<OtherEvent>.sync(
             (e) {
               // handle event e synchronously
               return true; // consume to stop propagation
             }
           ),
         ],
         child: Scaffold(
           appBar: AppBar(title: Text('My Page')),
           body: Center(child: Text('Content')),  
         ),
       );
     }
   }
   

3. Dispatch events from anywhere:

   // Since dispatch is now async, you can await it
   await PageCascadeNotifier.dispatch(MyEvent(...));
   
   // Or use without await if you don't need to wait for completion
   PageCascadeNotifier.dispatch(MyEvent(...));
   

4. Ensure you add the singleton CascadeNavigationTracker to your MaterialApp:

   MaterialApp(
     navigatorObservers: [CascadeNavigationTracker()],
     home: RootScreen(),
   );
   

---

🛠️ API Reference

CascadeEventHandler<T>

Wraps a typed handler function:

// Async handler (default)
CascadeEventHandler<NotificationEvent>(
  (e) async {
    // process e asynchronously
    await someAsyncOperation();
    return true;  // consume
  }
);

// Synchronous handler (using .sync constructor)
CascadeEventHandler<NotificationEvent>.sync(
  (e) {
    // process e synchronously
    return true;  // consume
  }
);

PageCascadeNotifier widget

Tracks context visibility and registers handlers:

• Constructor:

  • tabController + tabIndex (optional) for tabs
  • handlers: list of CascadeEventHandler<dynamic>
  • child: your page subtree

• Static methods:

  • dispatch(dynamic event): fire an event asynchronously (returns Future<void>)

CascadeNavigationTracker

A singleton RouteObserver<PageRoute> you must add to navigatorObservers:

MaterialApp(
  navigatorObservers: [CascadeNavigationTracker()],
  // ...
)

---

🔧 Example

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

class PingEvent { final String msg; PingEvent(this.msg); }

void main() => runApp(
  MaterialApp(
    navigatorObservers: [CascadeNavigationTracker()],
    home: HomeScreen(),
    builder: (ctx, child) => Stack(
      children: [ child!, Positioned(/* global FAB to dispatch */) ],
    ),
  ),
);

class HomeScreen extends StatelessWidget {
  @override Widget build(BuildContext c) => Scaffold(
    appBar: AppBar(title: Text('Home')),
    body: Center(child: ElevatedButton(
      child: Text('Go to Next'),
      onPressed: () => Navigator.push(
        c,
        MaterialPageRoute(builder: (_) => NextPage()),
      ),
    )),
  );
}

class NextPage extends StatelessWidget {
  @override Widget build(BuildContext c) {
    return PageCascadeNotifier(
      handlers: [
        CascadeEventHandler<PingEvent>((e) {
          // Show a SnackBar
          ScaffoldMessenger.of(c).showSnackBar(
            SnackBar(content: Text('Received: ${e.msg}')),
          );
          return true; // consume
        }),
      ],
      child: Scaffold(
        appBar: AppBar(title: Text('Next')), body: Center(child: Text('Waiting for event…')),
      ),
    );
  }
}

---

🧪 Testing

The package includes unit and widget tests under test/. To run:

flutter test

---

📋 Development with Melos

This package uses Melos to manage versioning and publishing.

Setup

After cloning the repository, run:

flutter pub get
dart pub global activate melos
melos bootstrap

Common Commands

# Run analyzer on all packages
melos run analyze

# Run tests on all packages
melos run test

# Publish the package (includes dry-run and confirmation)
melos run publish

# Bump version according to conventional commits
melos version

---

🤝 Contributing

1. Fork the repo: git clone https://github.com/your_org/event_cascade.git
2. Create a branch: git checkout -b feature/my-cool-feature
3. Commit changes & push
4. Open a Pull Request and describe your change

Please follow the existing style and add tests for new functionality.

---

📄 License

MIT © Prashant Sawant