Welcome to Nav 👋

Version License: Apache 2.0

Provide an easy way to navigate. Includes lots of routers. Available On Android & iOS


Add nav dependency on your pubspec.yaml file

nav: ^{latest version}


  1. Add mixin "Nav" on your App State
import 'package:nav/nav.dart';

class _MyAppState extends State<MyApp> with Nav 
  1. Overide "get navigatorKey method" and provide key which you use in MaterialApp.navigatorKey
class MyApp extends StatefulWidget {
  static GlobalKey<NavigatorState> navigatorKey = GlobalKey();
  // This widget is the root of your application.

  _MyAppState createState() => _MyAppState();

class _MyAppState extends State<MyApp> with Nav {
  GlobalKey<NavigatorState> get navigatorKey => MyApp.navigatorKey;

  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: navigatorKey,
  1. Use push methods
Nav.push(Widget, navAni: NavAni.Blink)

Nav.pushWithRippleEffect(Widget, centerAlignment : Alignment.bottomRight, centerOffset : Offset(10, 10))

enum NavAni { Left, Right, Top, Bottom, Fade, Ripple, Blink }
  1. All methods can return value
//from bottom screen
final result = await Nav.pushFromRight( TopScreen ) //you can get result from TopWidget

//from top screen
Nav.pop(context, result: {"key": "value", "key2": 2})


👤 Bansook Nam

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide(Contributions, issues and feature requests are welcome.).

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Bansook Nam.

This project is Apache 2.0 licensed.

This README was generated with ❤️ by readme-md-generator