ShellRoute class

Route that wraps a nested navigator. Usually for displaying a nav bar.

Inheritance

• Object
• HyperRoute<ShellValue>
• ShellRoute

Constructors

ShellRoute({required Widget shellBuilder(BuildContext context, ShellController controller, Widget child), required List<HyperRoute<RouteValue>> tabs, RouteKey? key})

Properties

children → List<HyperRoute<RouteValue>>

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

key → RouteKey

Same as RouteValue.key

final

parent ↔ HyperRoute<RouteValue>?

late, final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shellBuilder → Widget Function(BuildContext context, ShellController controller, Widget child)

The wrapper around the nested navigator. child is the nested navigator.

final

tabs → List<HyperRoute<RouteValue>>

final

Methods

createFromUrl(UrlData url) → RouteNode<RouteValue>?

Receives a list of url segments and returns the stack parsed from them. The first segment in the list is matched against this route. If it does not correspond to this route, returns null.

override

createNode({RouteNode<RouteValue>? next, ShellValue? value, Completer? popCompleter}) → RouteNode<RouteValue>

override

createStack({RouteNode<RouteValue>? next, required Map<Object, RouteValue> values, Map<Object, Completer> popCompleters = const {}}) → RouteNode<RouteValue>?

Creates a stack of RouteNodes from this route to the root.

inherited

forEach(void action(HyperRoute<RouteValue> r)) → void

inherited

nextNodeFromUrl(UrlData url) → RouteNode<RouteValue>?

Finds a route that matches the url among its children and returns a stack created from it.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateWithNext({RouteNode<RouteValue>? next, required ShellValue value, Completer? popCompleter}) → RouteNode<RouteValue>

Prioritizes next over value.

override

updateWithValue({RouteNode<RouteValue>? next, required ShellValue value, Completer? popCompleter}) → RouteNode<RouteValue>

Prioritizes value over next.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited