RouterWidgetState class

A state for a Router widget.

A reference to this class can be obtained by calling Router.of.

Inheritance

Constructors

RouterWidgetState()

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
currentPath → String
Gets the current path.
no setter
eventStream → ValueStream<RouterEvent>
Router event stream.
no setter
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
widget → Router
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant Router oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
inherited
findWidget<T extends Widget>() → T?
Returns the Widget of the nearest Page that is an instance of the given type T.
initState() → void
Called when this object is inserted into the tree.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pop<T extends Object?>([T? result]) → Future<bool>
Pops the top-most route.
popUntil(bool predicate(PageWrapper pageWrapper)) → void
Pops all the previous routes until the predicate returns true.
push(String path, {String? id}) → void
Pushes a new page by path.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
remove(String path) → void
Removes a route by path.
removeAllAndPush(String path, {String? id}) → void
Removes all routes then pushes a new page by path.
removeUntilAndPush(bool predicate(PageWrapper pageWrapper), String path, {String? id}) → void
Removes all the previous routes until the predicate returns true.
replace(String path, {String? id}) → void
Replace the current route by a new one by path.
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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