StateRouter class

A widget that renders different UI based on the current route state.

StateRouter listens to a RouteState and displays the corresponding widget from the provided routes map. If the current path does not match any route, a default 404 page is displayed.

Example:

final router = RouteState();

final routes = {
  '/': () => HomePage(),
  '/about': () => AboutPage(),
};

StateRouter(router: router, routes: routes);

Whenever router.go is called to change the path, StateRouter will automatically rebuild and show the corresponding widget.

Inheritance

Constructors

StateRouter({Key? key, required RouteState router, required Map<String, Widget Function()> routes})
Creates a StateRouter with the given router and routes.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
router → RouteState
The reactive router state that determines which route to display.
final
routes → Map<String, Widget Function()>
A mapping of route paths to their corresponding widget builders.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
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
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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