get_typed_router #

Type-safe, annotation-based route generation for GetX.

Pub Version

Stop writing routes manually. Annotate your pages with @AppRoute, run the generator, and get a fully typed AppRouter with type-safe navigation and strongly-typed argument passing.

Table of Contents #

• Features
• Installation
• Quick Start
  • 1. Annotate your pages
  • 2. Run the code generator
  • 3. Configure GetMaterialApp
• Navigation API
  • Full Navigation Reference
• Reading Arguments
  • Error handling
• The @AppRoute Annotation
  • Parameters
  • Supported page types
• Examples
• Contributing
• License

Features #

Installation #

Add get_typed_router to your pubspec.yaml:

dependencies:
  get: ^4.6.6
  get_typed_router: ^0.0.1

Then run:

flutter pub get

Quick Start #

1. Annotate your pages #

With typed arguments and a binding

import 'package:get/get.dart';
import 'package:get_typed_router/get_typed_router.dart';

// 1. Define your arguments class
class HomeArgs {
  final String title;
  HomeArgs({required this.title});
}

// 2. Annotate your page
@AppRoute<HomeArgs>(
  path: '/home',
  binding: HomeBinding,
)
class HomePage extends GetView<HomeController> {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text(controller.title)),
      body: const Center(child: Text('Welcome!')),
    );
  }
}

Without arguments (simple page)

@AppRoute(
  path: '/splash',
)
class SplashPage extends StatelessWidget {
  const SplashPage({super.key});

  @override
  Widget build(BuildContext context) {
    return const Scaffold(
      body: Center(child: Text('Loading...')),
    );
  }
}

2. Run the code generator #

From the root of your Flutter project:

dart run get_typed_router

This scans all .dart files in your lib/ directory and generates lib/routes/app_router.g.dart.

Tip: Add a script in your IDE or Makefile for convenience:

routes:
	dart run get_typed_router

3. Configure GetMaterialApp #

import 'routes/app_router.g.dart';

void main() => runApp(const MyApp());

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

  @override
  Widget build(BuildContext context) {
    return GetMaterialApp(
      initialRoute: HomePageRoute.route, // type-safe constant
      getPages: AppRouter.pages,         // auto-generated pages list
    );
  }
}

Navigation API #

All navigation methods are available through the generated AppRouter class:

Navigate to a route #

// Push a new route onto the stack
AppRouter.to(HomePageRoute(args: HomeArgs(title: 'Hello')));

Replace current route #

// Replace the current route (like Navigator.pushReplacement)
AppRouter.offNamed(HomePageRoute(args: HomeArgs(title: 'Hello')));

Clear stack and navigate #

// Remove all routes and navigate (like Navigator.pushAndRemoveAll)
AppRouter.offAllNamed(HomePageRoute(args: HomeArgs(title: 'Hello')));

Replace and push #

// Remove current route and push new one
AppRouter.offAndToNamed(HomePageRoute(args: HomeArgs(title: 'Hello')));

Navigate without arguments #

// For pages without typed args
AppRouter.to(SplashPageRoute());

Full Navigation Reference #

Reading Arguments #

Retrieve strongly-typed arguments in your page or controller:

final args = AppRouter.getArgs<HomeArgs>();
print(args.title); // fully typed, auto-completed

You can also fall back to the standard GetX approach:

final args = Get.arguments as HomeArgs;

Error handling #

getArgs<T>() throws a descriptive Exception when:

• No arguments are found — Exception('No arguments found for route')
• Wrong type — Exception('Invalid argument type. Expected HomeArgs but got String')

The @AppRoute Annotation #

@AppRoute<TArgs>(
  path: '/my-path',     // Required: the route path
  binding: MyBinding,   // Optional: GetX Binding class
)

Parameters #

Supported page types #

@AppRoute works with any widget class:

Examples #

Complete example with multiple pages #

// lib/pages/home_page.dart
import 'package:get_typed_router/get_typed_router.dart';

class HomeArgs {
  final String title;
  HomeArgs({required this.title});
}

@AppRoute<HomeArgs>(
  path: '/home',
  binding: HomeBinding,
)
class MyHomePage extends GetView<HomeController> {
  const MyHomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text(controller.title)),
      body: ElevatedButton(
        onPressed: () {
          // Type-safe navigation with arguments
          AppRouter.to(SecondPageRoute(args: 'Hello from Home!'));
        },
        child: const Text('Go to Second Page'),
      ),
    );
  }
}

// lib/pages/second_page.dart
import 'package:get_typed_router/get_typed_router.dart';

@AppRoute<String>(
  path: '/second',
)
class SecondPage extends StatelessWidget {
  const SecondPage({super.key});

  @override
  Widget build(BuildContext context) {
    // Type-safe argument retrieval
    final message = AppRouter.getArgs<String>();

    return Scaffold(
      appBar: AppBar(title: const Text('Second Page')),
      body: Center(child: Text('Received: $message')),
    );
  }
}

A full working example is available in the example/ folder.

Contributing #

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to submit pull requests, report bugs, and suggest features.

License #

This project is licensed under the MIT License — see the LICENSE file for details.