short_navigation 1.0.0

This package built to navigate between screens (routes) without using context (BuildContext).

Simple package helps you to do navigation in short line without using context (BuildCotext)

Features

You can navigation without context. Show dialog without context. Show bottomSheet without context. Show SnackBar without context and aything else without using any context. And this package will give you context variable to use it whenever and wherever in your code.

Getting started

In MaterialApp in main.dart you must pass [Go.navigatorKey] to [navigatorKey] property like this:

MaterialApp(
      navigatorKey: Go.navigatorKey, //Pass this navigatorKey here
      home:  home: const HomePage(),
    );

and after that you can use this package usefully.

Usage

Explaining of how to use this package

Global access to the app [context] using class [Go]

  ///If you need context in any file in your code you can use it
  Go.context;

Navigation using the default route [MaterialPageRoute] using class [Go]

  ///Instead of using [Navigator.of(context).push(MaterialPageRoute(builder: (context) => page));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go
  Go.to(HomePage());

  ///Instead of using [Navigator.of(context).pushReplacement(MaterialPageRoute(builder: (context) => page));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove previous route from the tree
  Go.toReplace(HomePage());
  
  ///Instead of using [Navigator.of(context).pushAndRemoveUntil(MaterialPageRoute(builder: (context) => page));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove all routes from the tree
  Go.toRemoveAll(HomePage());

  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your [widget] to go
  Go.backAndTo(HomePage());

Navigation using [DialogRoute] using class [GoDialogRoute]

  ///Instead of using [Navigator.of(context).push(DialogRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go
  GoDialogRoute.to(HomePage());

  ///Instead of using [Navigator.of(context).pushReplacement(DialogRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove previous route from the tree
  GoDialogRoute.toReplace(HomePage());
  
  ///Instead of using [Navigator.of(context).pushAndRemoveUntil(DialogRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove all routes from the tree
  GoDialogRoute.toRemoveAll(HomePage());

  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your [widget] to go
  GoDialogRoute.backAndTo(HomePage());

Navigation using [RawDialogRoute] using class [GoRawDialogRoute]

  ///Instead of using [Navigator.of(context).push(RawDialogRoute(.......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go
  GoRawDialogRoute.to(HomePage());

  ///Instead of using [Navigator.of(context).pushReplacement(RawDialogRoute(.......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove previous route from the tree
  GoRawDialogRoute.toReplace(HomePage());
  
  ///Instead of using [Navigator.of(context).pushAndRemoveUntil(RawDialogRoute(.......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove all routes from the tree
  GoRawDialogRoute.toRemoveAll(HomePage());

  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your [widget] to go
  GoRawDialogRoute.backAndTo(HomePage());

Navigation using [PageRouteBuilder] using class [GoPageRoute]

  ///Instead of using [Navigator.of(context).push(PageRouteBuilder(......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go
  GoPageRoute.to(HomePage());

  ///Instead of using [Navigator.of(context).pushReplacement(PageRouteBuilder(......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove previous route from the tree
  GoPageRoute.toReplace(HomePage());
  
  ///Instead of using [Navigator.of(context).pushAndRemoveUntil(PageRouteBuilder(......));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove all routes from the tree
  GoPageRoute.toRemoveAll(HomePage());

  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your [widget] to go
  GoPageRoute.backAndTo(HomePage());

Navigation using [ModalBottomSheetRoute] using class [GoBottomSheetRoute]

  ///Instead of using [Navigator.of(context).push(ModalBottomSheetRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go
  GoBottomSheetRoute.to(HomePage());

  ///Instead of using [Navigator.of(context).pushReplacement(ModalBottomSheetRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove previous route from the tree
  GoBottomSheetRoute.toReplace(HomePage());
  
  ///Instead of using [Navigator.of(context).pushAndRemoveUntil(ModalBottomSheetRoute(........));]
  ///This is simple navigation all you have to do
  ///just pass your [widget] to go and it will
  ///remove all routes from the tree
  GoBottomSheetRoute.toRemoveAll(HomePage());

  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your [widget] to go
  GoBottomSheetRoute.backAndTo(HomePage());

Navigation using route name

  ///Instead of using [Navigator.of(context).pushNamed("/homePage");]
  ///This is simple navigation all you have to do
  ///just passing your route [name] to go
  Go.toName("/homePage");

  ///Instead of using [Navigator.of(context).pushReplacementNamed("/homePage");]
  ///This is simple navigation all you have to do
  ///just pass your route [name] to go and it will
  ///remove previous route from the tree
  Go.toReplaceName("/homePage");

  ///Instead of using [Navigator.of(context).pushNamedAndRemoveUntil("/homePage");]
  ///This is simple navigation all you have to do
  ///just pass your route [name] to go and it will
  ///remove all routes from the tree
  Go.toNameRemoveAll("/homePage");

  ///Instead of using [Navigator.of(context).popAndPushNamed("/homePage");]
  ///If you want to pop sothing before
  ///pushing to another widget you could use it,
  ///just pass your route [name] to go
  Go.backAndToName("/homePage");

Back to previous page

  ///If you need to back to previous page you can [Go.back()],
  ///however if you need to pop many routes simply
  ///you have to use [Go.multiBack()] and pass how many time you want to pop
  ///using [numOfBacks].
  ///There is no need to pass [numOfBacks] if you just want to pop one time.

  ///Instead of using [Navigator.of(context).pop();]
  Go.back();

  ///Instead of using [Navigator.of(context)..pop()..pop()..pop();]
  ///If you wand to pop 3 pages
  Go.multiBack(3); //instate of Go.back(); Go.back(); Go.back();

  ///You can back as many as you want
  ///If you wand to pop 5 pages
  Go.multiBack(5);
  ///If you wand to pop 2 pages
  Go.multiBack(2);

Show [dialog, bottomSheet, snackBar, and materialBanner] using class [GoMessenger]

  ///Instead of using [showDialog(context: context,builder: (context) => MyCustomDialog());]
  ///If you wnat to [showDialog] without using context
  ///you have to use this function and the package will pass the context automaticlly.
  ///You can use all [showDialog] proparties as usuall.
  GoMessenger.dialog(MyCustomDialog());

  ///Instead of using [showModalBottomSheet(context: context, builder: (context) => content);]
  ///If you wnat to [showModalBottomSheet] without using context
  ///you have to use this function and the package will pass the context automaticlly.
  ///You can use all [showModalBottomSheet] proparties as usuall.
  GoMessenger.bottomSheet(MyCustomBottomSheet());

  ///Instead of using [ScaffoldMessenger.of(context).showSnackBar(snackBar);]
  ///If you wnat to [showSnackBar] without using context
  ///you have to use this function and the package will pass the context automaticlly.
  ///You can use all [showSnackBar] proparties as usuall.
  GoMessenger.snackBar(MyCustomSnackBar());

  ///Instead of using [ScaffoldMessenger.of(context).showMaterialBanner(materialBanner);]
  ///If you wnat to [showMaterialBanner] without using context
  ///you have to use this function and the package will pass the context automaticlly.
  ///You can use all [showMaterialBanner] proparties as usuall.
  GoMessenger.materialBanner(MyCustomMaterialBanner());

Global access to [Anything.of(context)] using class [GofContext]

    ///If you need any thing from [Theme.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.theme;

    ///If you need any thing from [ModalRoute.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.modalRoute;

    ///If you need any thing from [MediaQuery.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.mediaQuery;

    ///If you need any thing from [Focus.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.focus;

    ///If you need any thing from [FocusScope.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.focusScope;

    ///If you need any thing from [DefaultAssetBundle.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.defaultAssetBundle;

    ///If you need any thing from [MaterialLocalizations.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.materialLocalizations;

    ///If you need any thing from [Scaffold.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.scaffold;

    ///If you need any thing from [ScaffoldMessenger.of(context)]
    ///you can use it wherevere in your code without need any context.
    GofContext.scaffoldMessenger;

Additional information

I hope this package helped you very well. If you need to contact with me:

[[e-mail]]

[www.linkedin.com/in/mohammad-bahlaq-089882220]

[https://github.com/MohammadBahlaq]

Do not hesitate to contact me if you faced any problem.

Mohammad Bahlaq.