DartBoardNavigationDelegate class

Inheritance
Implemented types
Mixed in types

Constructors

DartBoardNavigationDelegate({required GlobalKey<NavigatorState> navigatorKey, required List<DartBoardDecoration> appDecorations, required String initialPath})

Properties

appDecorations → List<DartBoardDecoration>
final
changeNotifier → ChangeNotifier
Change Notifier to listen to changes in nav
no setteroverride
currentConfiguration → DartBoardPath?
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
currentPath → String
The currently active (foreground) route
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialDartBoardPath → DartBoardPath
latefinal
initialPath → String
final
The key used for retrieving the current navigator.
final
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stack → List<DartBoardPath>
Get the current stack
no setteroverride

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
appendPath(String path) → void
Append to the current route (e.g. /b appended to /a = /a/b)
override
build(BuildContext context) → Widget
Called by the Router to obtain the widget tree that represents the current state.
override
clearWhere(bool predicate(DartBoardPath path)) → void
Clear all routes in the stack that match the predicate
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() → void
Pop the top most route
override
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
popUntil(bool predicate(DartBoardPath path)) → void
Pop routers until the predicate clears
override
push(String path, {bool expanded = false}) → void
Push a route onto the stack expanded will push sub-paths (e.g. /a/b/c will push /a, /a/b, /a/b/c)
override
pushDynamic({required String dynamicPathName, required WidgetBuilder builder}) → void
Push a route with a dynamic route name
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
replaceRoot(String? path) → void
override
replaceTop(String path) → void
Pop & Push (replace top of stack) Does not work on '/'
override
setInitialRoutePath(DartBoardPath configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
inherited
setNewRoutePath(DartBoardPath path) → 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(DartBoardPath 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