openSheet<T> function

Future<T?> openSheet<T>({
  1. required BuildContext context,
  2. required WidgetBuilder builder,
  3. required OverlayPosition position,
  4. bool barrierDismissible = true,
  5. bool transformBackdrop = false,
  6. Color? barrierColor,
  7. bool draggable = false,
  8. AnimationController? animationController,
  9. WidgetBuilder? backdropBuilder,
  10. BoxConstraints? constraints,
  11. AlignmentGeometry? alignment,
})

Opens a sheet and returns a future that completes when dismissed.

Convenience function that opens a sheet overlay and returns the future directly, suitable for use with async/await patterns.

Returns: A Future that completes with the result when the sheet is dismissed.

Example:

final accepted = await openSheet<bool>(
  context: context,
  position: OverlayPosition.bottom,
  builder: (context) => ConfirmationSheet(),
);

Implementation

Future<T?> openSheet<T>({
  required BuildContext context,
  required WidgetBuilder builder,
  required OverlayPosition position,
  bool barrierDismissible = true,
  bool transformBackdrop = false,
  Color? barrierColor,
  bool draggable = false,
  AnimationController? animationController,
  WidgetBuilder? backdropBuilder,
  BoxConstraints? constraints,
  AlignmentGeometry? alignment,
}) {
  return openSheetOverlay<T>(
    context: context,
    builder: builder,
    position: position,
    barrierDismissible: barrierDismissible,
    transformBackdrop: transformBackdrop,
    barrierColor: barrierColor,
    draggable: draggable,
    animationController: animationController,
    backdropBuilder: backdropBuilder,
    constraints: constraints,
    alignment: alignment,
  ).future;
}