get_navigation/get_navigation library

A Refreshed 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
A widget that listens to back button events and provides custom back button handling.
CustomTransition
An abstract class representing a custom transition for animated route transitions.
Dependencies
A class to manage dependencies within the application. This class provides methods to register, find, delete, and manage dependencies in a centralized manner. It leverages GetX for state management and dependency injection. This allows for lazy loading, lifecycle management, and the ability to work with isolated instances when needed.
FadeInTransition
A class representing a fade-in transition animation.
GetBackGestureController<T>
GetBackGestureDetector<T>
A widget that detects back gestures for navigating back in a GetX-based application.
GetBackGestureDetectorState<T>
GetCupertinoApp
GetDelegate
GetInformationParser
GetMaterialApp
GetMiddleware
Middleware to handle page lifecycle events in a prioritized manner.
GetModalBottomSheetRoute<T>
A custom PopupRoute used by Refreshed for displaying modal bottom sheet routes.
GetNavigator
GetObserver
A custom NavigatorObserver for tracking route changes and managing routing data.
GetPage<T>
GetPageRoute<T>
GetRouterOutlet
A specialized RouterOutlet for GetX, handling nested routing and page generation.
GetSnackBar
A custom StatefulWidget for displaying snack bars.
GetSnackBarState
The state for managing a GetSnackBar widget.
IndexedRouteBuilder<T>
A widget that provides indexed routing for navigation items.
InheritedNavigator
An inherited widget for passing navigation state down the widget tree.
LeftToRightFadeTransition
A class representing a left-to-right fade transition animation.
MiddlewareRunner
Manages and executes GetMiddleware in a prioritized order.
Module
Abstract class representing a module in the application. Each module has its own UI and dependency setup.
ModuleState
State class that manages the lifecycle of the Module widget. It handles setting up dependencies and reporting route information.
NoTransition
A class representing a no transition animation.
PageRedirect
Handles page redirection in a GetX navigation context.
PageSettings
A custom implementation of RouteSettings representing settings specific to a page.
ParseRouteTree
A class representing a parsed route tree that manages route matching and manipulation for nested routing structures.
PathDecoded
RightToLeftFadeTransition
A class representing a right-to-left fade transition animation.
RouteDecoder
A class that decodes a route and provides information about the current route tree branch and associated page settings.
RouteListenerState
RouteReport
A widget that tracks and reports its route lifecycle events.
RouteReportState
The state associated with RouteReport.
RouterListener
A widget that listens to changes in the router delegate state.
RouterListenerInherited
An inherited widget to handle router listener states.
RouterListenerState
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
A widget that allows custom routing with GetX, helping in managing navigation and handling routing state across multiple routes in a nested manner.
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
State class for RouterOutlet, handling navigation state updates and back button handling.
Routing
Represents the current state of routing, including the current route, previous route, arguments, and other relevant information.
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
SnackBarQueue<T>
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 the status of a snackbar.
SnackHoverState
Indicates the state when the mouse enters or exits.
SnackPosition
Indicates the position where a snack is displayed.
SnackStyle
Indicates the style of a snack.
Transition
Enum defining various types of transitions that can be applied when navigating between routes.

Mixins

GetPageRouteTransitionMixin<T>
IGetNavigation
A mixin that provides navigation methods for managing routes in a Flutter application.
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>
Mixin to listen to changes in the router delegate state.

Extensions

BottomSheetExtension on GetInterface
DialogExtension on GetInterface
ExtensionSnackbar on GetInterface
FirstWhereOrNullExt on List<T>
Extension on List to provide a firstWhereOrNull method.
OverlayExtension on GetInterface
PageArgExtension on BuildContext
Extension methods for BuildContext to provide convenient access to page-related information.
PagesListExt on List<GetPage<T>>
Extension on List<GetPage> for enhanced routing functionality.

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

removeLastHistory(String? url) → void
Removes the last history entry from the browser history stack.
setUrlStrategy() → void
Sets the URL strategy to remove the hash from the URL.

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.
A widget builder for indexed navigation routes.
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.