get_navigation/get_navigation library

A Getx providing utilities and widgets for navigation management.

This includes features such as bottom sheets, route management, internationalization support, custom transitions, and snackbar display.

Classes

BackButtonCallback
CustomTransition
An abstract class representing a custom transition for animated route transitions.
Dependencies
FadeInTransition
A class representing a fade-in transition animation.
GetBackGestureController<T>
GetBackGestureDetector<T>
GetBackGestureDetectorState<T>
GetCupertinoApp
A CupertinoApp extension that integrates the Refreshed state management library.
GetDelegate
GetInformationParser
GetMaterialApp
A MaterialApp extension that integrates the Refreshed state management library.
GetMiddleware
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute<T>
A custom PopupRoute used by Refreshed for displaying modal bottom sheet routes.
GetNavigator
GetObserver
GetPage<T>
GetPageRoute<T>
GetRouterOutlet
GetSnackBar
A custom StatefulWidget for displaying snack bars.
GetSnackBarState
IndexedRouteBuilder<T>
InheritedNavigator
LeftToRightFadeTransition
A class representing a left-to-right fade transition animation.
MiddlewareRunner
Module
ModuleState
NoTransition
A class representing a no transition animation.
PageRedirect
PageSettings
A custom implementation of RouteSettings representing settings specific to a page.
ParseRouteTree
PathDecoded
RightToLeftFadeTransition
A class representing a right-to-left fade transition animation.
RouteDecoder
RouteListenerState
RouteReport
A StatefulWidget that reports its route lifecycle events to a RouterReportManager.
RouteReportState
The state for RouteReport.
RouterListener
RouterListenerInherited
RouterListenerState
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
SizeTransitions
A class representing a size transition animation.
SlideDownTransition
A class representing a slide-down transition animation.
SlideLeftTransition
A class representing a slide-left transition animation.
SlideRightTransition
A class representing a slide-right transition animation.
SlideTopTransition
A class representing a slide-top transition animation.
SnackbarController
Translations
Abstract class representing translations for an application.
ZoomInTransition
A class representing a zoom-in transition animation.

Enums

PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that shouldn't be duplicates
RowStyle
An enumeration representing different styles for rows.
SnackbarStatus
Indicates Status of snackbar SnackbarStatus.open Snack is fully open, SnackbarStatus.closed Snackbar has closed, SnackbarStatus.opening Starts with the opening animation and ends with the full snackbar display, SnackbarStatus.closing Starts with the closing animation and ends with the full snackbar dispose
SnackHoverState
Indicates if the mouse entered or exited
SnackPosition
Indicates if snack is going to start at the top or at the bottom
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
Transition
Enum defining various types of transitions that can be applied when navigating between routes.

Mixins

GetPageRouteTransitionMixin<T>
IGetNavigation
PageRouteReportMixin<T>
A mixin that provides page route lifecycle event reporting to a RouterReportManager.
RouteReportMixin<T extends StatefulWidget>
A mixin that provides route lifecycle event reporting to a RouterReportManager.
RouterListenerMixin<T extends StatefulWidget>

Constants

rtlLanguages → const List<String>
List of right-to-left (RTL) languages.

Properties

It replaces the Flutter Navigator, but needs no context. You can to use navigator.push(YourRoute()) rather Navigator.push(context, YourRoute());
no setter

Functions

cleanRouteName(String name) → String
Takes a route name String generated by to, off, offAll (and similar context navigation methods), cleans the extra chars and accommodates the format.
removeLastHistory(String? url) → void
setUrlStrategy() → void

Typedefs

GetPageBuilder = Widget Function()
Typedef representing a function that returns a widget.
GetRouteAwarePageBuilder<T> = Widget Function([GetPageRoute<T>? route])
Typedef representing a function that takes an optional GetPageRoute route parameter and returns a widget.
OnHover = void Function(GetSnackBar snack, SnackHoverState snackHoverState)
Callback signature for hover events on a GetSnackBar.
OnTap = void Function(GetSnackBar snack)
Callback signature for tap events on a GetSnackBar.
SnackbarStatusCallback = void Function(SnackbarStatus? status)
Callback signature for status changes on a GetSnackBar.