GetNavigator class

Inheritance
Available extensions

Constructors

GetNavigator({GlobalKey<NavigatorState>? key, bool onPopPage(Route, dynamic)?, required List<Page> pages, List<NavigatorObserver>? observers, bool reportsRouteUpdateToEngine = false, TransitionDelegate? transitionDelegate})

Properties

clipBehavior Clip
The content will be clipped (or not) according to this option.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
initialRoute String?
The name of the first route to show.
finalinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
marginZero Widget

Available on Widget, provided by the WidgetMarginX extension

no setter
observers List<NavigatorObserver>
A list of observers for this navigator.
finalinherited
onDidRemovePage DidRemovePageCallback?
Called when the Route associated with the given Page has been removed from the Navigator.
finalinherited
onGenerateInitialRoutes RouteListFactory
Called when the widget is created to generate the initial list of Route objects if initialRoute is not null.
finalinherited
onGenerateRoute RouteFactory?
Called to generate a route for a given RouteSettings.
finalinherited
onPopPage PopPageCallback?
This is deprecated and replaced by onDidRemovePage.
finalinherited
onUnknownRoute RouteFactory?
Called when onGenerateRoute fails to generate a route.
finalinherited
paddingZero Widget

Available on Widget, provided by the WidgetPaddingX extension

no setter
pages List<Page>
The list of pages with which to populate the history.
finalinherited
reportsRouteUpdateToEngine bool
Whether this navigator should report route update message back to the engine when the top-most route changes.
finalinherited
requestFocus bool
Whether or not the navigator and it's new topmost route should request focus when the new route is pushed onto the navigator.
finalinherited
restorationScopeId String?
Restoration ID to save and restore the state of the navigator, including its history.
finalinherited
routeTraversalEdgeBehavior TraversalEdgeBehavior
Controls the transfer of focus beyond the first and the last items of a focus scope that defines focus traversal of widgets within a route.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sliverBox Widget

Available on Widget, provided by the WidgetSliverBoxX extension

no setter
transitionDelegate TransitionDelegate
The delegate used for deciding how routes transition in or off the screen during the pages updates.
finalinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() NavigatorState
Creates the mutable state for this widget at a given location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
marginAll(double margin) Widget

Available on Widget, provided by the WidgetMarginX extension

marginOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

marginSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetMarginX extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paddingAll(double padding) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

paddingSymmetric({double horizontal = 0.0, double vertical = 0.0}) Widget

Available on Widget, provided by the WidgetPaddingX extension

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited