GeneratedRoute class

Generated route tree metadata.

Constructors

GeneratedRoute(String path, {Type? page, String? name, String resultType = 'void', List<GeneratedRoute> routes = const [], Type? shell, String? branch, List<Type> guards = const [], PageTransitionsBuilder? transition, bool fullscreenDialog = false, bool maintainState = true})
Creates generated route metadata.
const

Properties

branch → String?
Optional stateful navigation branch this route belongs to.
final
depthFirst → Iterable<GeneratedRoute>
Returns this route and every descendant in depth-first order.
no setter
fullscreenDialog → bool
Whether the generated page is presented as a fullscreen dialog.
final
guards → List<Type>
Guard classes for this generated route.
final
hashCode → int
The hash code for this object.
no setterinherited
maintainState → bool
Whether Flutter should keep the page state alive when inactive.
final
name → String?
Stable route name.
final
page → Type?
Page class built by this generated route entry.
final
path → String
Route path segment or absolute route path.
final
resultType → String
Generated route result type source.
final
routes → List<GeneratedRoute>
Nested generated routes grouped from child paths.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shell → Type?
Optional shell widget inherited by this generated route subtree.
final
transition → PageTransitionsBuilder?
Optional Flutter page transition builder for this route.
final

Methods

findByName(String name) → GeneratedRoute?
Finds the first route with name in this subtree.
findByPage(Type page) → GeneratedRoute?
Finds the first route whose page type is page in this subtree.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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