StackRouterActions class
The controller for invoking a set of actions on the stack router including pushing/popping routes and showing/hiding snack bars.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- ProxyWidget
- InheritedWidget
- StackRouterActions
Constructors
- StackRouterActions({required dynamic child, required dynamic pushRoute(String route), required dynamic popRoute([String route]), required void switchRoute(String route), required dynamic showSnackBar({String route, required StackRouterSnackBar snackBar}), required dynamic clearSnackBars({String route}), required dynamic hideSnackBar({String route}), dynamic key})
-
const
Properties
- child → Widget
-
The widget below this widget in the tree.
finalinherited
- clearSnackBars → dynamic Function({String route})
-
Clears all snack bars on the given route. Defaults to the current route.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideSnackBar → dynamic Function({String route})
-
Hides the current snack bar on the given route. Defaults to the current route.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- popRoute → dynamic Function([String route])
-
Pops the give route off the stack. Defaults to the current route.
final
- pushRoute → dynamic Function(String route)
-
Pushes the given route to the top of the stack.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showSnackBar → dynamic Function({String route, required StackRouterSnackBar snackBar})
-
Shows a snack bar on the given route. Defaults to the current route.
final
- switchRoute → void Function(String route)
-
Switches the current route to the provided route by moving it from its previous
position in the stack to the top or adding it to the top if it is not already present
in the stack's history.
final
Methods
-
createElement(
) → InheritedElement -
Inflates this configuration to a concrete instance.
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}) → 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
-
updateShouldNotify(
covariant StackRouterActions oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
of(
BuildContext context) → StackRouterActions?