M3EBottomSheetFrame class - m3e_bottom_sheet_frame library

Constructors

M3EBottomSheetFrame({required M3EBottomSheetVariant variant, required M3EBottomSheetTheme theme, required M3EBottomSheetLabels labels, required Widget child, bool showDragHandle = true, bool enableDrag = true, bool isDismissible = true, M3EBottomSheetValue initialValue = M3EBottomSheetValue.collapsed, double? previewHeight, bool expandToFullScreen = false, String? fullScreenTitle, M3EBottomSheetController? controller, ValueChanged<M3EBottomSheetValue>? onValueChanged, Future<bool> onDismiss()?, ValueChanged<Object?>? onClose, ValueListenable<double>? entrance, ValueListenable<double>? backProgress, FocusNode? handleFocusNode, SystemUiOverlayStyle? overlayStyle, Key? key}): M3EBottomSheetFrame.
const

Properties

backProgress → ValueListenable<double>?: Modal: predictive-back progress (0–1).
final
child → Widget: Sheet content.
final
controller → M3EBottomSheetController?: Optional controller.
final
enableDrag → bool: Whether dragging resizes the sheet.
final
entrance → ValueListenable<double>?: Modal: open progress (0 hidden, 1 shown).
final
expandToFullScreen → bool: Adds a full-screen height with a header; the sheet spans the width.
final
fullScreenTitle → String?: Title in the full-screen header.
final
handleFocusNode → FocusNode?: Focus node for the drag handle.
final
hashCode → int: The hash code for this object.
no setterinherited
initialValue → M3EBottomSheetValue: Height to rest at first.
final
isDismissible → bool: Standard only: whether dragging down may hide the sheet.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
labels → M3EBottomSheetLabels: Accessibility strings.
final
onClose → ValueChanged<Object?>?: Modal: closes without guards and pops Object as the result.
final
onDismiss → Future<bool> Function()?: Modal: guarded dismissal. Resolves false to stay open.
final
onValueChanged → ValueChanged<M3EBottomSheetValue>?: Called when the sheet rests at a new height.
final
overlayStyle → SystemUiOverlayStyle?: System bar style where the sheet sits under a system bar. Null leaves the bars to the page below.
final
previewHeight → double?: Standard only: optional peek height.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showDragHandle → bool: Whether to show the drag handle.
final
theme → M3EBottomSheetTheme: Resolved sheet theme.
final
variant → M3EBottomSheetVariant: Standard or modal.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<M3EBottomSheetFrame>: 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, int wrapWidth = 65}) → 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