AutoRouterDelegate class
An auto_route implementation for RouterDelegate
- Inheritance
-
- Object
- Listenable
- RouterDelegate<
UrlState> - AutoRouterDelegate
- Mixed-in types
Constructors
- AutoRouterDelegate(StackRouter controller, {WidgetBuilder? placeholder, DeepLinkBuilder? deepLinkBuilder, bool rebuildStackOnDeepLink = false, Listenable? reevaluateListenable})
- Default constructor
Properties
- controller → StackRouter
-
An object that provides pages stack to Navigator.pages
and wraps a navigator key to handle stack navigation actions
final
- currentConfiguration → UrlState?
-
Called by the Router when it detects a route information may have
changed as a result of rebuild.
no setteroverride
- deepLinkBuilder → DeepLinkBuilder?
-
Clients can use this to intercept deep-links
coming from platform and validate, abort or override it.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
-
A builder function that returns a list of observes
final
-
Passed to Navigator.restorationScopeId
final
- placeholder → WidgetBuilder?
-
A builder for the placeholder page that is shown
before the first route can be rendered. Defaults to
an empty page with
Theme.scaffoldBackgroundColor.final - rebuildStackOnDeepLink → bool
-
if set to true the new stack
will replace the old one on
deep-links coming from the platform
final
- reevaluateListenable → Listenable?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- urlState → UrlState
-
Helper to access current urlState
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).
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
notifyUrlChanged(
) → void - Force this delegate to rebuild
-
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(
UrlState configuration) → Future< void> -
Called by the Router at startup with the structure that the
RouteInformationParser obtained from parsing the initial route.
override
-
setNewRoutePath(
UrlState 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(
UrlState 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
- Builds an empty observers list
-
of(
BuildContext context) → AutoRouterDelegate - Looks up and casts the scoped Router to AutoRouterDelegate
-
reportUrlChanged(
BuildContext context, String url) → dynamic - Forces a url update