ParallelRoute<T> class

Inheritance
Implementers

Constructors

ParallelRoute({ModularChild? child, required String name, void popCallback(dynamic)?, bool maintainState = true, String parent = '', String schema = '', TransitionType? transition, CustomTransition? customTransition, Duration? duration, bool isFullscreenDialog = false, List<ModularRoute> children = const [], List<Middleware> middlewares = const [], Module? module, Uri? uri, Map<Type, Module> innerModules = const {}})
ParallelRoute.child(String name, {required ModularChild child, CustomTransition? customTransition, List<ParallelRoute> children = const [], Duration? duration, TransitionType? transition, bool isFullscreenDialog = false, List<Middleware> middlewares = const []})
factory
ParallelRoute.empty()
factory
ParallelRoute.module(String name, {required Module module, List<Middleware> middlewares = const []})
factory

Properties

child ModularChild?
Widget Builder that will be called when prompted in navigation.
final
children List<ModularRoute>
Add children to this route that can be retrieved through the parent route
finalinherited
customTransition CustomTransition?
Defines a custom transition. If the transition is TransitionType.custom, it becomes mandatory to add a CustomTransition() object.
final
duration Duration?
define the Transition duration Default is 300 milliseconds
final
hashCode int
The hash code for this object.
no setterinherited
innerModules Map<Type, Module>
Contains a list of all BindContexts that will need to be active when this route is active.
finalinherited
isFullscreenDialog bool
Whether this page route is a full-screen dialog. Default is false;
final
key ↔ ModularKey
Key that references the route in the RouteContext tree.
latefinalinherited
maintainState bool
Whether the route should remain in memory when it is inactive. If this is true, then the route is maintained, so that any futures it is holding from the next route will properly resolve when the next route pops. If this is not necessary, this can be set to false to allow the framework to entirely discard the route's widget hierarchy when it is not visible. If this getter would ever start returning a different value, the changedInternalState should be invoked so that the change can take effect.
final
middlewares List<Middleware>
Adds middleware that will be shared among your children.
finalinherited
module Module?
Module belonging to the route.
getter/setter pairinherited
name String
name of route
finalinherited
parent String
guard your parent's path
finalinherited
popCallback → (void Function(dynamic)?)
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
schema String
schema of route default is ''
finalinherited
transition TransitionType?
Transition performed when one page overlaps another. default is TransitionType.defaultTransition;
final
transitions Map<TransitionType, PageRouteBuilder<T> Function(ModularChild builder, Duration transitionDuration, RouteSettings settings, bool maintainState)>
final
uri Uri
latefinalinherited

Methods

addModule(String name, {required Module module}) ParallelRoute<T>
Create a new Route by adding a RouteContext to the context.
override
addParent(covariant ParallelRoute parent) ModularRoute
override
copyWith({ModularChild? child, Module? module, TransitionType? transition, CustomTransition? customTransition, Duration? duration, bool? isFullscreenDialog, String? name, String? schema, void popCallback(dynamic)?, List<Middleware>? middlewares, List<ModularRoute>? children, String? parent, Uri? uri, Map<ModularKey, ModularRoute>? routeMap, Map<Type, Module>? innerModules}) ParallelRoute<T>
override
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