UrlRouter class

Inheritance
Mixed-in types

Constructors

UrlRouter.new({String url = '/', List<Page> onGeneratePages(UrlRouter router)?, Widget builder(UrlRouter router, Widget navigator)?, PopPageCallback? onPopPage, String? onChanging(UrlRouter router, String newLocation)?})

Properties

builder → Widget Function(UrlRouter router, Widget navigator)?
Wrap widgets around the MaterialApps Navigator widget. Primarily used for providing scaffolding like a SideBar, TitleBar around the page stack. Also useful for when you would like to discard the provided Navigator, and implement your own.
final
context ↔ BuildContext
Set from inside the build method, allows us to avoid passing context into delegates
getter/setter pair
currentConfiguration → String?
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
The key used for retrieving the current navigator.
no setteroverride
onChanging ↔ String? Function(UrlRouter router, String newLocation)?
Optionally invoked just prior to the location being changed. Allows a parent class to protect or redirect certain routes. The callback can return the original url to allow the location change, or return a new url to redirect. If null is returned the location change will be ignored / blocked.
getter/setter pair
onGeneratePages → List<Page> Function(UrlRouter router)?
Should build a stack of pages, based on the current location. This is technically optional, as you could decide to implement your own custom navigator inside the builder
final
onPopPage → PopPageCallback?
Optionally provide a way for the parent to implement custom onPopPage logic.
final
queryParams ↔ Map<String, String>
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
url ↔ String
getter/setter pair
urlPath → String
no setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
pop([Map<String, String>? queryParams]) → void
popRoute() → Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
inherited
push(String path, [Map<String, String>? queryParams]) → void
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setInitialRoutePath(String configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
override
setNewRoutePath(String configuration) → SynchronousFuture<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(String configuration) → Future<void>
Called by the Router during state restoration.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

of(BuildContext context) → UrlRouter
Enable UrlRouter.of(context) lookup