BottomSheet class

A Material Design bottom sheet.

There are two kinds of bottom sheets in Material Design:

  • Persistent. A persistent bottom sheet shows information that supplements the primary content of the app. A persistent bottom sheet remains visible even when the user interacts with other parts of the app. Persistent bottom sheets can be created and displayed with the ScaffoldState.showBottomSheet function or by specifying the Scaffold.bottomSheet constructor parameter.

  • Modal. A modal bottom sheet is an alternative to a menu or a dialog and prevents the user from interacting with the rest of the app. Modal bottom sheets can be created and displayed with the showModalBottomSheet function.

The BottomSheet widget itself is rarely used directly. Instead, prefer to create a persistent bottom sheet with ScaffoldState.showBottomSheet or Scaffold.bottomSheet, and a modal bottom sheet with showModalBottomSheet.

See also:

Inheritance

Constructors

BottomSheet({Key? key, AnimationController? animationController, bool enableDrag = true, bool? showDragHandle, Color? dragHandleColor, Size? dragHandleSize, BottomSheetDragStartHandler? onDragStart, BottomSheetDragEndHandler? onDragEnd, Color? backgroundColor, Color? shadowColor, double? elevation, ShapeBorder? shape, Clip? clipBehavior, BoxConstraints? constraints, required VoidCallback onClosing, required WidgetBuilder builder})
Creates a bottom sheet.
const

Properties

animationController AnimationController?
The animation controller that controls the bottom sheet's entrance and exit animations.
final
backgroundColor Color?
The bottom sheet's background color.
final
builder WidgetBuilder
A builder for the contents of the sheet.
final
clipBehavior Clip?
The content will be clipped (or not) according to this option.
final
constraints BoxConstraints?
Defines minimum and maximum sizes for a BottomSheet.
final
dragHandleColor Color?
The bottom sheet drag handle's color.
final
dragHandleSize Size?
Defaults to BottomSheetThemeData.dragHandleSize. If that is also null, defaults to Size(32, 4).
final
elevation double?
The z-coordinate at which to place this material relative to its parent.
final
enableDrag bool
If true, the bottom sheet can be dragged up and down and dismissed by swiping downwards.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onClosing VoidCallback
Called when the bottom sheet begins to close.
final
onDragEnd BottomSheetDragEndHandler?
Called when the user stops dragging the bottom sheet, if enableDrag is true.
final
onDragStart BottomSheetDragStartHandler?
Called when the user begins dragging the bottom sheet vertically, if enableDrag is true.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shadowColor Color?
The color of the shadow below the sheet.
final
shape ShapeBorder?
The shape of the bottom sheet.
final
showDragHandle bool?
Specifies whether a drag handle is shown.
final

Methods

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

Static Methods

createAnimationController(TickerProvider vsync) AnimationController
Creates an AnimationController suitable for a BottomSheet.animationController.