GetPage<T> class

A page configuration for a route within the GetX navigation system.

This class extends Page and provides additional properties and methods specific to GetX routing.

Inheritance

Constructors

GetPage({required String name, required GetPageBuilder page, String? title, bool? participatesInRootNavigator, double gestureWidth(BuildContext context)?, bool maintainState = true, Curve curve = Curves.linear, Alignment? alignment, Map<String, String>? parameters, bool opaque = true, Duration? transitionDuration, Duration? reverseTransitionDuration, bool? popGesture, BindingsInterface? binding, List<BindingsInterface> bindings = const <BindingsInterface<dynamic>>[], List<Bind> binds = const <Bind<dynamic>>[], Transition? transition, CustomTransition? customTransition, bool fullscreenDialog = false, List<GetPage> children = const <GetPage<dynamic>>[], List<GetMiddleware> middlewares = const <GetMiddleware<dynamic>>[], GetPage? unknownRoute, Object? arguments, bool showCupertinoParallax = true, bool preventDuplicates = true, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.reorderRoutes, Completer<T?>? completer, bool inheritParentPath = true, LocalKey? key})
Creates a GetPage with the specified configuration.

Properties

alignment → Alignment?
The alignment of the route within the screen.
final
arguments → Object?
The arguments passed to this route.
final
binding → BindingsInterface?
The bindings to be associated with the route.
final
bindings → List<BindingsInterface>
Additional bindings to be associated with the route.
final
binds → List<Bind>
Data binding configurations for the route.
final
canPop → bool
When false, blocks the associated route from being popped.
finalinherited
children → List<GetPage>
The nested routes.
final
completer → Completer<T?>?
A completer for the route.
final
curve → Curve
The animation curve for the transition.
final
customTransition → CustomTransition?
Custom transition animation for the route.
final
fullscreenDialog → bool
Whether the route should be displayed as a fullscreen dialog.
final
gestureWidth → double Function(BuildContext context)?
The width of the gesture area for edge-swipe navigation.
final
hashCode → int
The hash code for this object.
no setteroverride
inheritParentPath → bool
Whether to inherit the parent path for nested routes.
final
key → LocalKey?
The key associated with this page.
finalinherited
maintainState → bool
Whether the route should maintain its state when pushed or popped.
final
middlewares → List<GetMiddleware>
Middlewares for the route.
final
name → String
The route name.
final
onPopInvoked → PopInvokedWithResultCallback<T>
Called after a pop on the associated route was handled.
finalinherited
opaque → bool
Whether the route should obscure the entire screen.
final
page → GetPageBuilder
The builder function that returns the widget for the route.
final
parameters → Map<String, String>?
Parameters associated with the route.
final
participatesInRootNavigator → bool?
Whether the route should be displayed as a fullscreen dialog.
final
path → PathDecoded
The path regex for the route.
final
popGesture → bool?
Whether the route should support pop gesture to navigate back.
final
preventDuplicateHandlingMode → PreventDuplicateHandlingMode
The handling mode for preventing duplicate routes.
final
preventDuplicates → bool
Whether to prevent duplicate routes.
final
restorationId → String?
Restoration ID to save and restore the state of the Route configured by this page.
finalinherited
reverseTransitionDuration → Duration?
The duration of the reverse transition animation.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showCupertinoParallax → bool
Whether to show the Cupertino-style parallax effect for iOS.
final
title → String?
The title of the route.
final
transition → Transition?
The transition animation to use when navigating to the route.
final
transitionDuration → Duration?
The duration of the transition animation.
final
unknownRoute → GetPage?
The unknown route for handling navigation to undefined routes.
final

Methods

canUpdate(Page other) → bool
Whether this page can be updated with the other page.
inherited
copyWith({LocalKey? key, String? name, GetPageBuilder? page, bool? popGesture, Map<String, String>? parameters, String? title, Transition? transition, Curve? curve, Alignment? alignment, bool? maintainState, bool? opaque, List<BindingsInterface>? bindings, BindingsInterface<T>? binding, List<Bind>? binds, CustomTransition? customTransition, Duration? transitionDuration, Duration? reverseTransitionDuration, bool? fullscreenDialog, RouteSettings? settings, List<GetPage<T>>? children, GetPage? unknownRoute, List<GetMiddleware>? middlewares, bool? preventDuplicates, double gestureWidth(BuildContext context)?, bool? participatesInRootNavigator, Object? arguments, bool? showCupertinoParallax, Completer<T?>? completer, bool? inheritParentPath}) → GetPage<T>
Creates a copy of this GetPage with the given fields replaced by the new values.
createRoute(BuildContext context) → Route<T>
Creates the Route that corresponds to this page.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override