go_router_express #

An Express.js-like wrapper for go_router .

Usage #

final express = GoRouterExpress((app) {
  app.get('/todos/:id', [], (req, res) {
    final id = req.params('id');
    res.page(TodoPage(id: id));
  });
});

void main() {
  runApp(const MyApp());
}

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp.router(routerConfig: express.router);
  }
}

Middleware #

class AuthMiddleware extends WidgetMiddleware {
  @override
  Widget build(WidgetRequest req, WidgetResponse res, Widget Function() next) {
    if (req.query('token') == null) {
      return const UnauthorizedPage();
    }
    return next();
  }
}

final express = GoRouterExpress((app) {
  app.get('/admin', [AuthMiddleware()], (req, res) {
    res.page(const AdminPage());
  });
});

Navigation #

go_router is re-exported, so you can use all go_router extensions:

// go - replace navigation stack
context.go('/next-page');

// push - add to navigation stack
context.push('/detail-page');

// pop - go back
context.pop();

// From button
ElevatedButton(
  onPressed: () => context.go('/detail'),
  child: const Text('Go to Detail'),
);

Issues #

For bug reports and feature requests, please visit: GitHub issues

License #

MIT

📖 Japanese Documentation