VoDashboard class

The signed-in shell: app bar, bottom dock, drawer and end drawer around the current pane.

Panes stay alive after they are first shown (keepPanesAlive), so tabs keep their scroll position and state. Back closes an open drawer, then returns to the previously visited pane, then pops the route.

Changing initialPaneKey later shows that pane, so a route parameter can drive the current pane.

Inheritance

Constructors

VoDashboard({Key? key, required String initialPaneKey, VoDashboardController? controller, List<VoDashboardPane>? dockPanes, List<VoDashboardPane>? drawerPanes, List<VoDashboardPane>? endDrawerPanes, Widget? bottomSheet, Widget? floatingActionButton, VoDashboardBodyTransition? bodyAnimationBuilder, List<Widget>? persistentFooterButtons, @Deprecated('The dashboard is ready on its first frame; this is unused.') WidgetBuilder? loadingBuilder, ValueChanged<String>? onPaneChanged, ValueChanged<String>? onPaneReselected, bool keepPanesAlive = true, VoDashboardTheme? style})
const

Properties

bodyAnimationBuilder → VoDashboardBodyTransition?
Animates a pane in when it becomes current.
final
bottomSheet → Widget?
final
controller → VoDashboardController?
Drives the dashboard from outside. Created internally when null.
final
dockPanes → List<VoDashboardPane>?
final
drawerPanes → List<VoDashboardPane>?
final
endDrawerPanes → List<VoDashboardPane>?
final
floatingActionButton → Widget?
Shown on panes with showFloatingActionButton that don't build their own.
final
hashCode → int
The hash code for this object.
no setterinherited
initialPaneKey → String
final
keepPanesAlive → bool
Keeps panes mounted after they are first shown. When false, a pane is rebuilt from scratch each time it is shown.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingBuilder → WidgetBuilder?
final
onPaneChanged → ValueChanged<String>?
final
onPaneReselected → ValueChanged<String>?
Called when the user taps the pane that is already showing, e.g. to scroll it to the top.
final
persistentFooterButtons → List<Widget>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
style → VoDashboardTheme?
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<VoDashboard>
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.
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