RouteGuard class
A widget that guards a route based on the provided state.
If state is AsyncData with false, it redirects to fallbackPath.
If state is AsyncData with true, it ensures the user is on destinationPath.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- RouteGuard
Constructors
-
RouteGuard({required BaseAsyncValue<
bool> state, required void onRedirect(BuildContext context), required Widget child, required Widget loadingWidget, required Widget errorWidgetBuilder(Object error, StackTrace? stackTrace), Key? key}) -
Creates a RouteGuard.
const
Properties
- child → Widget
-
The widget to display if access is granted.
final
- errorWidgetBuilder → Widget Function(Object error, StackTrace? stackTrace)
-
Widget builder to display if the guard state encounters an error.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingWidget → Widget
-
Widget to display while the guard state is loading.
final
- onRedirect → void Function(BuildContext context)
-
Callback to handle redirection.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ BaseAsyncValue<
bool> -
The current state of the guard check.
final
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