OverDialog class

Show a dialog

Constructors

OverDialog({required Widget child, Offset offset = Offset.zero, OverlayActions actions = const OverlayActions(), OverAnimation? animation, EdgeInsets? margin, double? height, BoxDecoration? decoration, BackgroundSettings? backgroundSettings = const BackgroundSettings(blur: 1), double? width, Duration? duration, bool addInsetsPaddings = false, Color? color, String? name, Key? key})

Properties

actions → OverlayActions

set custom actions to the overlay events. See OverlayActions for more details

final

addInsetsPaddings → bool

This will defines if the overlay should have the insets padding of the device This is used for example to move the overly if the keyboard is opened This is true as default for OverPanels and Expanders and false for the rest

final

animation ↔ OverAnimation

The animation that will be used to show the overlay. You can use OverFadeAnimation, OverSlideAnimation or OverScaleAnimation

late, final

backgroundSettings → BackgroundSettings?

You can use this class to set the background color and the background blur of the layer behind the overlay. if you set the dismissOnClick to true, the overlay will be dismissed when you on the background layer.

final

child → Widget

The content of your Dialog

final

color → Color?

The overlay background color. If the decoration is set, this property will be ignored.

final

decoration → BoxDecoration?

The overlay decoration.

final

duration → Duration?

the time to keep the overlay open. When the time is over, the overlay will be closed automatically. If the value is null, the overlay will not be closed automatically.

final

hashCode → int

The hash code for this object.

no setter, inherited

height → double?

The dialog height, if null, the dialog will be fit to the content

final

margin → EdgeInsets?

the overlay margin

final

name → String

a unique name for the overlay. If you don't set a name, the overlay will be named with the class name. You can use this name to close the overlay later

final

offset → Offset

The offset from the dialog position With this offset, you can move the dialog position for example for up or down left or right

final

overlayAnimation ↔ OverlayAnimation

the animation when the overlay is shown

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

width → double?

The dialog width, if null, the dialog will be fit to the content

final

Methods

buildEntries() → List<OverlayEntry>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

show<T>({BuildContext? context}) → Future<T?>

show this overlay

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited