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:



BottomSheet({Key key, AnimationController animationController, bool enableDrag: true, BottomSheetDragStartHandler onDragStart, BottomSheetDragEndHandler onDragEnd, Color backgroundColor, double elevation, ShapeBorder shape, Clip clipBehavior, @required VoidCallback onClosing, @required WidgetBuilder builder})
Creates a bottom sheet. [...]


animationController AnimationController
The animation controller that controls the bottom sheet's entrance and exit animations. [...]
backgroundColor Color
The bottom sheet's background color. [...]
builder WidgetBuilder
A builder for the contents of the sheet. [...]
clipBehavior Clip
The content will be clipped (or not) according to this option. [...]
elevation double
The z-coordinate at which to place this material relative to its parent. [...]
enableDrag bool
If true, the bottom sheet can be dragged up and down and dismissed by swiping downwards. [...]
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
onClosing VoidCallback
Called when the bottom sheet begins to close. [...]
onDragEnd BottomSheetDragEndHandler
Called when the user stops dragging the bottom sheet, if enableDrag is true. [...]
onDragStart BottomSheetDragStartHandler
Called when the user begins dragging the bottom sheet vertically, if enableDrag is true. [...]
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
shape ShapeBorder
The shape of the bottom sheet. [...]


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
createState() → _BottomSheetState
Creates the mutable state for this widget at a given location in the tree. [...]
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toDiagnosticsNode({String name, DiagnosticsTreeStyle style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep. [...]
toString({DiagnosticLevel minLevel:}) String
Returns a string representation of this object.
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants. [...]
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object. [...]
toStringShort() String
A short, textual description of this widget.


operator ==(Object other) bool
The equality operator. [...]
@nonVirtual, inherited

Static Methods

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