CustomRoute class

Builds an AutoRoute instance with RouteType.custom type

Inheritance

• Object
• AutoRoute
• CustomRoute

Annotations

• @immutable

Constructors

CustomRoute({required PageInfo page, bool fullscreenDialog = false, bool maintainState = true, bool fullMatch = false, List<AutoRouteGuard> guards = const [], bool usesPathAsKey = false, List<AutoRoute>? children, Map<String, dynamic> meta = const {}, TitleBuilder? title, String? path, bool keepHistory = true, bool initial = false, bool allowSnapshotting = true, RouteTransitionsBuilder? transitionsBuilder, CustomRouteBuilder? customRouteBuilder, int? durationInMilliseconds, int? reverseDurationInMilliseconds, bool opaque = true, bool barrierDismissible = true, String? barrierLabel, RestorationIdBuilder? restorationId, Color? barrierColor})

Default constructor

Properties

allowSnapshotting → bool

Whether the target route should allow snapshotting. Passed To PageRoute.allowSnapshotting

final, inherited

children → RouteCollection?

The nested child-entries of this route

no setter, inherited

fullMatch → bool

Weather to match this route's path as fullMatch

final, inherited

fullscreenDialog → bool

Whether to treat the target route as a fullscreenDialog. Passed To PageRoute.fullscreenDialog

final, inherited

guards → List<AutoRouteGuard>

The list of AutoRouteGuard's the matched route will go through before being presented

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasSubTree → bool

Whether is route is a parent route

no setter, inherited

initial → bool

Marks route as initial destination of a router

final, inherited

keepHistory → bool

Whether the target route should be kept in stack after another route is pushed above it

final, inherited

maintainState → bool

Whether the target route should maintain it's state. Passed To PageRoute.maintainState

final, inherited

meta → Map<String, dynamic>

a Map of dynamic data that can be accessed by RouteData.meta when the route is created

final, inherited

name → String

The name of page this route should map to

final, inherited

path → String

The path defined by user or automatically-added By RouteCollection.fromList

no setter, inherited

restorationId → RestorationIdBuilder?

Builds a String value that that's passed to AutoRoutePage.restorationId

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → TitleBuilder?

Builds page title that's passed to _PageBasedCupertinoPageRoute.title where it can be used by CupertinoNavigationBar

final, inherited

type → RouteType?

Indicates what kind of PageRoute this route will use e.g MaterialRouteType will create _PageBasedMaterialPageRoute

final, inherited

usesPathAsKey → bool

If set to true the AutoRoutePage will use the matched-path as it's key otherwise name will be used

final, inherited

Methods

changePath(String path) → AutoRoute

A simplified copyWith

inherited

copyWith({RouteType? type, String? name, String? path, bool? usesPathAsKey, List<AutoRouteGuard>? guards, bool? fullMatch, Map<String, dynamic>? meta, bool? maintainState, bool? fullscreenDialog, List<AutoRoute>? children, TitleBuilder? title, RestorationIdBuilder? restorationId, bool? keepHistory, bool? initial, bool? allowSnapshotting}) → AutoRoute

A simplified copyWith

inherited

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