Flow Routing

The next-generation Flutter router — typed, fast, and built from first principles.

Published on pub.dev as flow_routing.

context.go(HomeRoute());
context.push(UserRoute(id: 42, tab: UserTab.profile));
context.pop();

UserRoute(id: 5).location; // → "/users/5?tab=profile"

Why Flow?

Features

• Typed routes — UserRoute(id: 42) not '/users/42'
• Reverse routing — URLs generated automatically via .location
• Pipeline guards — composable auth, roles, async validation
• Middleware — logging, analytics, localization hooks
• Separated stacks — declarative go vs imperative push overlays
• Web support — clean URLs, browser history, refresh-safe parsing
• Transitions — material, fade, slide, none
• Shell routes — nested navigation and tab branches
• Testing — FakeFlowRouter, engine unit tests, widget tests
• Migration — helpers for GoRouter, Navigator, AutoRoute, Beamer

Quick Start

dependencies:
  flow_routing: ^1.0.0

import 'package:flow_routing/flow_routing.dart';

final router = FlowRouter(
  routes: [
    FlowLeafNode(FlowRouteDefinition<HomeRoute>(
      name: 'home',
      pathTemplate: '/',
      builder: (context, route) => const HomePage(),
      factory: (_) => const HomeRoute(),
    )),
  ],
);

void main() => runApp(FlowApp.router(router: router));

See Getting Started for the full guide.

Example App

A polished demo showcasing typed navigation, guards, middleware, and web URLs:

cd example
flutter run -d chrome   # Web
flutter run             # Mobile

Documentation

Project Structure

flow/
├── lib/           # Package source
├── example/       # Demo application
├── docs/          # Documentation
├── test/          # Unit & widget tests
└── benchmark/     # Performance benchmarks

License

MIT — see LICENSE.