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.

Constructors

BottomSheet({Key key, AnimationController animationController, bool enableDrag: true, double elevation: 0.0, @required VoidCallback onClosing, @required WidgetBuilder builder }): Creates a bottom sheet. [...]
const

animationController → AnimationController: The animation that controls the bottom sheet's position. [...]
final
builder → WidgetBuilder: A builder for the contents of the sheet. [...]
final
elevation → double: The z-coordinate at which to place this material. This controls the size of the shadow below the material. [...]
final
enableDrag → bool: If true, the bottom sheet can dragged up and down and dismissed by swiping downards. [...]
final
onClosing → VoidCallback: Called when the bottom sheet begins to close. [...]
final
hashCode → int: The hash code for this object. [...]
read-only, inherited
key → Key: Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited

createState() → _BottomSheetState: Creates the mutable state for this widget at a given location in the tree. [...]
override
createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
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. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String: Returns 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

createAnimationController(TickerProvider vsync) → AnimationController: Creates an animation controller suitable for controlling a BottomSheet.