CustomRoute<T> class

Inheritance

• Object
• AutoRoute<T>
• CustomRoute

Annotations

• @optionalTypeArgs

Constructors

CustomRoute({bool initial = false, bool fullscreenDialog = false, bool maintainState = true, String? name, String? path, bool fullMatch = false, required Type page, List<Type>? guards, bool usesPathAsKey = false, List<AutoRoute>? children, Function? customRouteBuilder, String? barrierLabel, int? barrierColor, Function? transitionsBuilder, int? durationInMilliseconds, int? reverseDurationInMilliseconds, bool opaque = true, bool barrierDismissible = false, Map<String, dynamic> meta = const {}})

const

Properties

barrierColor → int?

passed to the barrierColor property in PageRouteBuilder

final

barrierDismissible → bool

passed to the barrierDismissible property in PageRouteBuilder

final

barrierLabel → String?

passed to the barrierLabel property in PageRouteBuilder

final

children → List<AutoRoute>?

final, inherited

customRouteBuilder → Function?

this builder function is passed to customRouteBuilder property in CustomPage

final

durationInMilliseconds → int?

route transition duration in milliseconds is passed to PageRouteBuilder this property is ignored unless a transitionBuilder is provided

final

fullMatch → bool

final, inherited

fullscreenDialog → bool

passed to the fullscreenDialog property in MaterialPageRoute

final, inherited

guards → List<Type>?

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

initial → bool

final, inherited

maintainState → bool

passed to the maintainState property in MaterialPageRoute

final, inherited

meta → Map<String, dynamic>

meta data

final, inherited

name → String?

final, inherited

opaque → bool

passed to the opaque property in PageRouteBuilder

final

page → Type?

final, inherited

path → String?

route path name which will be assigned to the given variable name const homeScreen = 'path'; if null a kabab cased variable name prefixed with '/' will be used; homeScreen -> home-screen

final, inherited

reverseDurationInMilliseconds → int?

route reverse transition duration in milliseconds is passed to PageRouteBuilder this property is ignored unless a transitionBuilder is provided

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transitionsBuilder → Function?

this builder function is passed to the transition builder function in PageRouteBuilder

final

usesPathAsKey → bool

if true path is used as page key instead of name

final, inherited

Methods

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