DashboardWidget class

A widget that displays navigation information and controls during active navigation.

This widget shows:

Remaining distance to destination
Estimated travel time
Estimated time of arrival

When expanded, it provides additional features:

Sound settings toggle for navigation instructions
Route overview button
Navigation end button

The widget requires:

controller - A DashboardController instance to manage state and actions
onHeaderChangeSize - Callback to handle header size changes for layout adjustments This callback is used by NavigationLayoutWidget to measure height of dashboard and layout other widgets accordingly to it. This callback is always provided in builder of NavigationLayoutWidget and should be called with Offset of upmost point of this widget.

Optionally accepts:

onFinishClicked - Custom callback invoked when user finishes route by clicking on button. Default is to call controller.stopNavigation().
light/dark - Custom theme configurations

Usage example:

DashboardWidget(
  controller: dashboardController,
  onHeaderChangeSize: (offset) {
    // Handle header size change
  },
  onFinishClicked: () {
    // Custom navigation end handling
  },
)

This widget is typically created automatically by NavigationLayoutWidget through its builder pattern, but can also be used independently or extended for custom navigation interfaces.

Constructors

DashboardWidget({required DashboardController controller, required dynamic onHeaderChangeSize(Offset), dynamic onFinishClicked()?, Key? key, DashboardWidgetTheme? light, DashboardWidgetTheme? dark}): const

Properties

controller → DashboardController: final
dark → DashboardWidgetTheme: finalinherited
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
light → DashboardWidgetTheme: finalinherited
onFinishClicked → dynamic Function()?: final
onHeaderChangeSize → dynamic Function(Offset): final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

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

Static Methods

defaultBuilder(DashboardController controller, dynamic onHeaderChangeSize(Offset)) → DashboardWidget