ExpressiveShellScaffold class
The scaffold that owns an app's navigation: body (the branches), and one labelled item per tabs entry, in branch order, with the action and the accessory.
The bar stands while barVisible (it slides away on a spatial spring,
the accessory and the action with it), a tab is chosen through
onDestinationSelected, and every branch root reserves the band the bar
stands in through ShellInsets — measured, so a taller label (a larger
text scale) or accessory is reserved too.
ExpressiveShellScaffold(tabs: tabs, selectedIndex: tab, onDestinationSelected: (i) => setState(() => tab = i), body: IndexedStack(index: tab, children: branches))
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ExpressiveShellScaffold
Constructors
-
ExpressiveShellScaffold({required List<
NavTab> tabs, required int selectedIndex, required ValueChanged<int> onDestinationSelected, required Widget body, bool barVisible = true, ShellAction? action, Widget? accessory, Key? key}) -
A shell standing
bodyunder the navigation fortabs.const
Properties
- accessory → Widget?
-
What docks above the bar and yields with it.
final
- action → ShellAction?
-
The app-level act reachable from every root: a floating action button.
final
- barVisible → bool
-
Whether the bar (with the action and the accessory) stands: false
while a page is pushed over a branch root.
final
- body → Widget
-
The branches: every one kept, the selected one on show.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onDestinationSelected
→ ValueChanged<
int> -
Told the branch a tap on the bar or the rail chose.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedIndex → int
-
The branch on show.
final
-
tabs
→ List<
NavTab> -
One per branch, in branch order.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ExpressiveShellScaffold> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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.
override
-
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