VoDashboardPane class

One shell row: chrome (dock / drawer / end drawer) and optional body.

Inheritance

Constructors

VoDashboardPane.divider({String title = '', Color? color, double? strokeWidth, EdgeInsets padding = EdgeInsets.zero, EdgeInsets margin = EdgeInsets.zero, BoxDecoration? decoration, TextStyle? textStyle, VoDashboardDividerStyle? style, bool isEndDrawer = false})
Section divider. isEndDrawer sets site for validation.
VoDashboardPane.dock({required String key, required String title, required VoDashboardPaneBodyBuilder? builder, String? subtitle, VoTileState<IconData>? icon, IconData? iconData, VoTileIconBuilder? iconBuilder, VoTileTapWithContext<VoDashboardPane>? onPressed, VoTileBuilder<VoTile>? tileBuilder, bool showAppBar = true, bool showDrawer = true, bool extendBody = true, bool showEndDrawer = true, bool showFloatingActionButton = true, VoDashboardPaneFabBuilder? floatingActionButtonBuilder, VoDashboardPaneAppBarBuilder? appBarActionsBuilder, VoDashboardPaneLeadingBuilder? appBarLeadingBuilder})
Primary tab; shows dock when this pane is active.
VoDashboardPane.drawer({required String key, required String title, VoDashboardPaneBodyBuilder? builder, String? subtitle, VoTileState<IconData>? icon, IconData? iconData, VoTileIconBuilder? iconBuilder, VoTileTapWithContext<VoDashboardPane>? onPressed, VoTileBuilder<VoTile>? tileBuilder, bool showDock = true, bool showAppBar = true, bool showDrawer = true, bool extendBody = true, bool showEndDrawer = true, bool showFloatingActionButton = false, VoDashboardPaneFabBuilder? floatingActionButtonBuilder, VoDashboardPaneAppBarBuilder? appBarActionsBuilder, VoDashboardPaneLeadingBuilder? appBarLeadingBuilder})
Start drawer menu item.
VoDashboardPane.endDrawer({required String key, required String title, VoDashboardPaneBodyBuilder? builder, String? subtitle, VoTileState<IconData>? icon, IconData? iconData, VoTileIconBuilder? iconBuilder, VoTileTapWithContext<VoDashboardPane>? onPressed, VoTileBuilder<VoTile>? tileBuilder, bool showDock = true, bool showAppBar = true, bool showDrawer = true, bool extendBody = true, bool showEndDrawer = true, VoTileTrailingBuilder? trailingBuilder, bool showFloatingActionButton = false, VoDashboardPaneFabBuilder? floatingActionButtonBuilder, VoDashboardPaneAppBarBuilder? appBarActionsBuilder, VoDashboardPaneLeadingBuilder? appBarLeadingBuilder})
End drawer menu item.
VoDashboardPane.spacer({double? width})
Vertical gap in the dock row.
VoDashboardPane.stickyBottom({required String key, required String title, VoDashboardPaneBodyBuilder? builder, String? subtitle, VoTileState<IconData>? icon, IconData? iconData, VoTileIconBuilder? iconBuilder, VoTileTapWithContext<VoDashboardPane>? onPressed, VoTileBuilder<VoTile>? tileBuilder, bool showAppBar = true, bool showDrawer = true, bool extendBody = true, bool showEndDrawer = true, VoTileTrailingBuilder? trailingBuilder, bool showFloatingActionButton = false, VoDashboardPaneFabBuilder? floatingActionButtonBuilder, VoDashboardPaneAppBarBuilder? appBarActionsBuilder, VoDashboardPaneLeadingBuilder? appBarLeadingBuilder, bool isEndDrawer = false})
Pinned above drawer footer; does not scroll.

Properties

appBarActionsBuilder → VoDashboardPaneAppBarBuilder?
final
appBarLeadingBuilder → VoDashboardPaneLeadingBuilder?
final
builder → VoDashboardPaneBodyBuilder?
final
configSignature → int
Stable signature for detecting pane-list config changes.
no setter
dividerStyle → VoDashboardDividerStyle?
final
extendBody → bool
final
floatingActionButtonBuilder → VoDashboardPaneLeadingBuilder?
final
hashCode → int
The hash code for this object.
no setterinherited
hasIcon → bool
True if the tile has an icon builder.
no setteroverride
hasTrailing → bool
True if the tile has a trailing builder.
no setterinherited
icon → VoTileState<IconData>?
final
iconBuilder → VoTileIconBuilder?
finalinherited
isChromeOnly → bool
no setter
isExpanded → bool
finalinherited
isNavigable → bool
no setter
key → String
finalinherited
onPressed → VoTileTapWithContext<VoDashboardPane>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showAppBar → bool
final
showDock → bool
final
showDrawer → bool
final
showEndDrawer → bool
final
showFloatingActionButton → bool
final
site → VoDashboardSite
final
spacerWidth → double?
final
subtitle → String?
finalinherited
tileBuilder → VoTileBuilder<VoTile>?
finalinherited
title → String
finalinherited
trailingBuilder → VoTileTrailingBuilder?
finalinherited
type → VoDashboardPaneType
final

Methods

buildDividerWidget() → Widget
buildIcon(bool isActive, double? size, Color? color) → Widget?
Builds the icon for the tile. @param isActive - True if the tile is active. @param size - The size of the icon. @param color - The color of the icon. @return The icon widget.
override
buildSpacerWidget(double defaultWidth) → Widget
copyWith({bool? showDock, bool? showAppBar, bool? showDrawer, bool? extendBody, bool? showEndDrawer, bool? showFloatingActionButton, VoDashboardDividerStyle? dividerStyle, VoTileBuilder<VoTile>? tileBuilder, VoTileTrailingBuilder? trailingBuilder, VoTileIconBuilder? iconBuilder, VoDashboardPaneFabBuilder? floatingActionButtonBuilder, VoDashboardPaneAppBarBuilder? appBarActionsBuilder, VoDashboardPaneLeadingBuilder? appBarLeadingBuilder}) → VoDashboardPane
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

listConfigSignature(List<VoDashboardPane>? panes) → int
mergeRegistry({required List<VoDashboardPane> dockPanes, List<VoDashboardPane> drawerPanes = const [], List<VoDashboardPane> endDrawerPanes = const []}) → Map<String, VoDashboardPane>
validateForSite(List<VoDashboardPane> panes, VoDashboardSite expected) → void