get_navigation/src/routes/index library

Classes

BackButtonCallback
CustomTransition
An abstract class representing a custom transition for animated route transitions.
Dependencies
A class to manage dependencies within the application.
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>
GetDelegate<T>
GetInformationParser<T>
A route information parser for decoding route information into RouteDecoder.
GetMiddleware<T>
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetNavigator
GetObserver
GetPage<T>
A page configuration for a route within the GetX navigation system.
GetPageRoute<T>
GetRouterOutlet
IndexedRouteBuilder<T>
InheritedNavigator
LeftToRightFadeTransition
A class representing a left-to-right fade transition animation.
MatchResult
A class representing the result of a route matching operation.
MiddlewareRunner
Module
Abstract class representing a module in the application.
ModuleState
This class represents the state of a module.
NoTransition
A class representing a no transition animation.
PageRedirect
PageSettings
A custom implementation of RouteSettings representing settings specific to a page.
ParseRouteTree<T>
PathDecoded
Represents a decoded path pattern used for route matching.
RightToLeftFadeTransition
A class representing a right-to-left fade transition animation.
RouteDecoder<T>
RouteListenerState
RouteMatcher
RouteNode
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>
RouteTree
RouteTreeResult
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.
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
Transition
Enum defining various types of transitions that can be applied when navigating between routes.

Mixins

GetPageRouteTransitionMixin<T>
IGetNavigation<T>
A mixin for navigation functionality.
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>

Extensions

FirstWhereOrNullExt on Iterable<T>
Extension providing a firstWhereOrNull function to find the first element satisfying a condition.
PageArgExtension on BuildContext
Extension methods for BuildContext to provide convenient access to page-related information.
PagesListExt on List<GetPage<T>>

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
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.