ModularRouterDelegate class

Inheritance

• Object
• Listenable
• RouterDelegate<ModularPage<PageParameters>>
• ModularRouterDelegate

Mixed in types

• ChangeNotifier
• PopNavigatorRouterDelegateMixin<ModularPage<PageParameters>>

Constructors

ModularRouterDelegate({required GlobalKey<NavigatorState> navigatorKey, required RootModule rootModule, ModularPage<PageParameters> setInitialRoutePathOverride(ModularPage<PageParameters> configuration)?})

Properties

canPop → bool

no setter

currentConfiguration → ModularPage<PageParameters>?

Called by the Router when it detects a route information may have changed as a result of rebuild.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

history → List<ModularHistory<PageParameters, ModularPage<PageParameters>>>

no setter

navigatorKey → GlobalKey<NavigatorState>

The key used for retrieving the current navigator.

final

rootModule → RootModule

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setInitialRoutePathOverride → (ModularPage<PageParameters> Function(ModularPage<PageParameters> configuration)?)

final

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

addModuleGuards(BaseModule module, List<FutureOr<bool> Function(ModularHistory<PageParameters, ModularPage<PageParameters>> route, ModularRouterDelegate delegate)> guards) → void

build(BuildContext context) → Widget

Called by the Router to obtain the widget tree that represents the current state.

override

dispose() → void

Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).

inherited

navigateToLink(ModularLink<PageParameters> link, {bool clearHistory = false, bool removeCurrent = false}) → FutureOr<void>

navigateToPage(ModularPage<PageParameters> page, {bool clearHistory = false, bool removeCurrent = false}) → FutureOr<void>

navigateToUri(Uri uri, {bool clearHistory = false, bool removeCurrent = false}) → FutureOr<void>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

Call all the registered listeners.

inherited

pop() → bool

popRoute() → Future<bool>

Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.

override

removeListener(VoidCallback listener) → void

Remove a previously registered closure from the list of closures that are notified when the object changes.

inherited

setInitialRoutePath(ModularPage<PageParameters> configuration) → Future<void>

Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.

override

setNewRoutePath(ModularPage<PageParameters> configuration) → Future<void>

Called by the Router when the Router.routeInformationProvider reports that a new route has been pushed to the application by the operating system.

override

setRestoredRoutePath(ModularPage<PageParameters> configuration) → Future<void>

Called by the Router during state restoration.

inherited

testGuards<TPageParameters extends PageParameters, TModularPage extends ModularPage<TPageParameters>>(BaseModularRoute<PageParameters, ModularPage<PageParameters>> route, ModularHistory<TPageParameters, TModularPage> history) → FutureOr<bool>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited