AutoRouter class

A Wrapper for Navigator that handles stack-routing

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• AutoRouter

Constructors

AutoRouter({Key? key, NavigatorObserversBuilder navigatorObservers = AutoRouterDelegate.defaultNavigatorObserversBuilder, Widget builder(BuildContext context, Widget content)?, String? navRestorationScopeId, GlobalKey<NavigatorState>? navigatorKey, bool inheritNavigatorObservers = true, WidgetBuilder? placeholder})

Default constructor

const

Properties

builder → (Widget Function(BuildContext context, Widget content)?)

This builder maybe used to build content with context that has AutoRouterState.controller

final

hashCode → int

The hash code for this object.

no setter, inherited

inheritNavigatorObservers → bool

Whether this router should inherit it's ancestor's observers

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

navigatorKey → GlobalKey<NavigatorState>?

The state key passed to Navigator

final

navigatorObservers → NavigatorObserversBuilder

A builder function that returns a list of observes

final

navRestorationScopeId → String?

Passed to Navigator.restorationScopeId

final

placeholder → WidgetBuilder?

A builder for the placeholder page that is shown before the first route can be rendered. Defaults to an empty page with Theme.scaffoldBackgroundColor.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<AutoRouter>

Creates the mutable state for this widget at a given location in the tree.

override

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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}) → 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

Static Methods

declarative({Key? key, NavigatorObserversBuilder navigatorObservers = AutoRouterDelegate.defaultNavigatorObserversBuilder, required RoutesBuilder routes, RoutePopCallBack? onPopRoute, String? navRestorationScopeId, bool inheritNavigatorObservers = true, GlobalKey<NavigatorState>? navigatorKey, OnNestedNavigateCallBack? onNavigate, WidgetBuilder? placeholder}) → Widget

Builds a _DeclarativeAutoRouter which uses a declarative list of routes to update navigator stack

innerRouterOf(BuildContext context, String routeName) → StackRouter?

Helper to access RoutingController.innerRouterOf

of(BuildContext context, {bool watch = false}) → StackRouter

Looks up and returns the scoped StackRouter