DrawerConfiguration<T> class

OverlayConfiguration that presents its content as a side/bottom drawer (with backdrop transform).

Already the mobile-appropriate mechanism, so adaptiveConversion is the identity conversion (no adaptation performed).

Inheritance

Constructors

DrawerConfiguration({Anchor? anchor, required WidgetBuilder builder, OverlayPosition position = OverlayPosition.bottom, bool expands = false, bool draggable = true, bool barrierDismissible = true, WidgetBuilder? backdropBuilder, bool useSafeArea = true, bool? showDragHandle, BorderRadiusGeometry? borderRadius, Size? dragHandleSize, bool transformBackdrop = true, double? surfaceOpacity, double? surfaceBlur, Color? barrierColor, AnimationController? animationController, bool autoOpen = true, BoxConstraints? constraints, AlignmentGeometry? alignment})
Creates a DrawerConfiguration.
const

Properties

alignment → AlignmentGeometry?
Alignment within constraints.
final
anchor → Anchor?
The Anchor to resolve against (LinkedAnchor for an anchor key registered via OverlayAnchor, or ContextAnchor), if using anchor-based positioning instead of the BuildContext passed to show.
final
animationController → AnimationController?
Custom animation controller.
final
autoOpen → bool
Whether to automatically open on creation.
final
backdropBuilder → WidgetBuilder?
Custom backdrop builder.
final
barrierColor → Color?
Color of the modal barrier.
final
barrierDismissible → bool
Whether tapping the barrier dismisses the drawer.
final
borderRadius → BorderRadiusGeometry?
Corner radius for the drawer.
final
builder → WidgetBuilder
Builds the drawer content.
final
constraints → BoxConstraints?
Size constraints for the drawer.
final
draggable → bool
Whether the drawer can be dragged to dismiss.
final
dragHandleSize → Size?
Size of the drag handle.
final
expands → bool
Whether the drawer expands to fill available space.
final
hashCode → int
The hash code for this object.
no setterinherited
position → OverlayPosition
The edge the drawer slides in from.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showDragHandle → bool?
Whether to show a drag handle.
final
surfaceBlur → double?
Blur intensity for surface effects.
final
surfaceOpacity → double?
Opacity for surface effects.
final
transformBackdrop → bool
Whether to scale/transform the backdrop.
final
useSafeArea → bool
Whether to respect device safe areas.
final

Methods

adaptiveConversion(BuildContext context) → OverlayConfiguration<T>
Returns an equivalent configuration adapted for the current platform, e.g. a PopoverConfiguration becomes a DrawerConfiguration on mobile.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
show(BuildContext context) → OverlayCompleter<T?>
Actually presents the overlay using this configuration's mechanism.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited