DialogConfiguration<T> class

OverlayConfiguration that presents its content as a modal dialog via Navigator/DialogRoute.

Dialogs are usually an intentional choice regardless of platform, so adaptiveConversion is the identity conversion (no adaptation performed).

showDialog only exposes a Future, so OverlayCompleter.remove and OverlayCompleter.dispose do nothing here. Close the dialog with Navigator.pop or closeOverlay instead.

Inheritance

Constructors

DialogConfiguration({required WidgetBuilder builder, bool useRootNavigator = true, bool barrierDismissible = true, Color? barrierColor, String? barrierLabel, bool useSafeArea = true, RouteSettings? routeSettings, Offset? anchorPoint, TraversalEdgeBehavior? traversalEdgeBehavior, AlignmentGeometry? alignment, bool fullScreen = false}): Creates a DialogConfiguration.
const

alignment → AlignmentGeometry?: Dialog alignment, defaults to center.
final
anchorPoint → Offset?: Anchor point for transitions.
final
barrierColor → Color?: Color of the backdrop barrier.
final
barrierDismissible → bool: Whether tapping outside dismisses the dialog.
final
barrierLabel → String?: Semantic label for the barrier.
final
builder → WidgetBuilder: Builds the dialog content.
final
fullScreen → bool: Whether to display in full-screen mode.
final
hashCode → int: The hash code for this object.
no setterinherited
routeSettings → RouteSettings?: Settings for the route.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
traversalEdgeBehavior → TraversalEdgeBehavior?: Focus traversal edge behavior.
final
useRootNavigator → bool: Whether to use the root navigator.
final
useSafeArea → bool: Whether to respect device safe areas.
final

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