Class Navigator

Inheritance
Object
Diagnosticable
DiagnosticableTree
CanonicalMixinDiagnosticableTree
Widget
StatefulWidget
Navigator
Inherited Members
Namespace: Unity.UIWidgets.widgets
Syntax
public class Navigator : StatefulWidget

Constructors

Navigator(Key, String, RouteFactory, RouteFactory, List<NavigatorObserver>)

Declaration
public Navigator(Key key = null, string initialRoute = null, RouteFactory onGenerateRoute = null, RouteFactory onUnknownRoute = null, List<NavigatorObserver> observers = null)
Parameters
Type Name Description
Key key
String initialRoute
RouteFactory onGenerateRoute
RouteFactory onUnknownRoute
List<NavigatorObserver> observers

Fields

defaultRouteName

Declaration
public static readonly string defaultRouteName
Field Value
Type Description
String

initialRoute

Declaration
public readonly string initialRoute
Field Value
Type Description
String

observers

Declaration
public readonly List<NavigatorObserver> observers
Field Value
Type Description
List<NavigatorObserver>

onGenerateRoute

Declaration
public readonly RouteFactory onGenerateRoute
Field Value
Type Description
RouteFactory

onUnknownRoute

Declaration
public readonly RouteFactory onUnknownRoute
Field Value
Type Description
RouteFactory

Methods

canPop(BuildContext)

Declaration
public static bool canPop(BuildContext context)
Parameters
Type Name Description
BuildContext context
Returns
Type Description
Boolean

createState()

Declaration
public override State createState()
Returns
Type Description
State
Overrides

maybePop(BuildContext, Object)

Declaration
public static IPromise<bool> maybePop(BuildContext context, object result = null)
Parameters
Type Name Description
BuildContext context
Object result
Returns
Type Description
IPromise<Boolean>

of(BuildContext, Boolean, Boolean)

Declaration
public static NavigatorState of(BuildContext context, bool rootNavigator = false, bool nullOk = false)
Parameters
Type Name Description
BuildContext context
Boolean rootNavigator
Boolean nullOk
Returns
Type Description
NavigatorState

pop(BuildContext, Object)

Declaration
public static bool pop(BuildContext context, object result = null)
Parameters
Type Name Description
BuildContext context
Object result
Returns
Type Description
Boolean

popAndPushNamed(BuildContext, String, Object, Object)

Declaration
public static IPromise<object> popAndPushNamed(BuildContext context, string routeName, object result = null, object arguments = null)
Parameters
Type Name Description
BuildContext context
String routeName
Object result
Object arguments
Returns
Type Description
IPromise<Object>

popUntil(BuildContext, RoutePredicate)

Declaration
public static void popUntil(BuildContext context, RoutePredicate predicate)
Parameters
Type Name Description
BuildContext context
RoutePredicate predicate

push(BuildContext, Route)

Declaration
public static IPromise<object> push(BuildContext context, Route route)
Parameters
Type Name Description
BuildContext context
Route route
Returns
Type Description
IPromise<Object>

pushAndRemoveUntil(BuildContext, Route, RoutePredicate)

Declaration
public static IPromise<object> pushAndRemoveUntil(BuildContext context, Route newRoute, RoutePredicate predicate)
Parameters
Type Name Description
BuildContext context
Route newRoute
RoutePredicate predicate
Returns
Type Description
IPromise<Object>

pushNamed(BuildContext, String, Object)

Declaration
public static IPromise<object> pushNamed(BuildContext context, string routeName, object arguments = null)
Parameters
Type Name Description
BuildContext context
String routeName
Object arguments
Returns
Type Description
IPromise<Object>

pushNamedAndRemoveUntil(BuildContext, String, RoutePredicate, Object)

Declaration
public static IPromise<object> pushNamedAndRemoveUntil(BuildContext context, string newRouteName, RoutePredicate predicate, object arguments = null)
Parameters
Type Name Description
BuildContext context
String newRouteName
RoutePredicate predicate
Object arguments
Returns
Type Description
IPromise<Object>

pushReplacement(BuildContext, Route, Object)

Declaration
public static IPromise<object> pushReplacement(BuildContext context, Route newRoute, object result = null)
Parameters
Type Name Description
BuildContext context
Route newRoute
Object result
Returns
Type Description
IPromise<Object>

pushReplacementNamed(BuildContext, String, Object, Object)

Declaration
public static IPromise<object> pushReplacementNamed(BuildContext context, string routeName, object result = null, object arguments = null)
Parameters
Type Name Description
BuildContext context
String routeName
Object result
Object arguments
Returns
Type Description
IPromise<Object>

removeRoute(BuildContext, Route)

Declaration
public static void removeRoute(BuildContext context, Route route)
Parameters
Type Name Description
BuildContext context
Route route

replace(BuildContext, Route, Route)

Declaration
public static void replace(BuildContext context, Route oldRoute = null, Route newRoute = null)
Parameters
Type Name Description
BuildContext context
Route oldRoute
Route newRoute

replaceRouteBelow(BuildContext, Route, Route)

Declaration
public static void replaceRouteBelow(BuildContext context, Route anchorRoute = null, Route newRoute = null)
Parameters
Type Name Description
BuildContext context
Route anchorRoute
Route newRoute