BottomSheetBar class

A toolbar that aligns to the bottom of a widget and expands into a bottom sheet.

Inheritance

Constructors

BottomSheetBar({required Widget body, required Widget expandedBuilder(ScrollController), Widget? collapsed, BottomSheetBarController? controller, Color? color, Color backdropColor = Colors.transparent, BorderRadius? borderRadius, BorderRadius? borderRadiusExpanded, List<BoxShadow>? boxShadows, double height = kToolbarHeight, bool isDismissable = true, bool locked = true, double velocityMin = 320.0, bool backButtonListener = false, bool willPopScope = false, Key? key})
const

Properties

backButtonListener bool
Enable wrapping BottomSheetBar in BackButtonListener
final
backdropColor Color
The backdrop color that overlays the body widget when the bottom sheet is expanded. Defaults to Colors.transparent (no backdrop)
final
body Widget
The toolbar will be aligned to the bottom of the body Widget. Padding equal to height is added to the bottom of this widget.
final
borderRadius BorderRadius?
Provide a border-radius to adjust the shape of the toolbar
final
borderRadiusExpanded BorderRadius?
Provide a border-radius to adjust the shape of the bottom-sheet when expanded
final
boxShadows List<BoxShadow>?
Provide a box-shadow list to add to Ink widget
final
collapsed Widget?
A Widget to be displayed on the toolbar in its collapsed state. When null, the toolbar will be empty.
final
color Color?
The background color of the toolbar and bottom sheet. Defaults to Theme.of(context).bottomAppBarColor
final
controller BottomSheetBarController?
A controller can be used to listen to events, and expand and collapse the bottom sheet.
final
expandedBuilder Widget Function(ScrollController)
A function to build the widget displayed when the bottom sheet is expanded. If the expanded content is scrollable, pass the provided ScrollController to the scrollable widget.
final
hashCode int
The hash code for this object.
no setterinherited
height double
The height of the collapsed toolbar. Defaults to kToolbarHeight (56.0)
final
isDismissable bool
If true, the bottom sheet can be dismissed by tapping elsewhere. Defaults to true
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
locked bool
If true, the bottom sheet cannot be opened or closed with a swipe gesture. Defaults to true
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
velocityMin double
The minimum vertical speed (measured in pixels-per-second) required to collapse or expand the bottom-sheet with a fling gesture
final
willPopScope bool
Enable wrapping BottomSheetBar in WillPopScope
final

Methods

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