ArnaAlertDialog class

An Arna-styled alert dialog.

An alert dialog informs the user about situations that require acknowledgement. An alert dialog has an optional title and an optional list of actions. The title is displayed above the content and the actions are displayed below the content.

If the content is too large to fit on the screen vertically, the dialog will display the title and the actions and let the content overflow, which is rarely desired. Consider using a scrolling widget for content, such as SingleChildScrollView, to avoid overflow. (However, be aware that since ArnaAlertDialog tries to size itself using the intrinsic dimensions of its children, widgets such as ListView, GridView, and CustomScrollView, which use lazy viewports, will not work. If this is a problem, consider using ArnaDialog directly.)

Typically passed as the child widget to showArnaDialog, which displays the dialog.

{@tool snippet}

This snippet shows a method in a State which, when called, displays a dialog box and returns a Future that completes when the dialog is dismissed.

Future<void> _showMyDialog() async {
  return showArnaDialog<void>(
    context: context,
    barrierDismissible: false, // user must tap button!
    builder: (BuildContext context) {
      return ArnaAlertDialog(
        title: 'AlertDialog Title',
        content: SingleChildScrollView(
          child: ListBody(
            children: const <Widget>[
              Text('This is a demo alert dialog.'),
              Text('Would you like to approve of this message?'),
            ],
          ),
        ),
        actions: <Widget>[
          ArnaButton.text(
            label: 'Approve',
            onPressed: () {
              Navigator.of(context).pop();
            },
          ),
        ],
      );
    },
  );
}

{@end-tool}

See also:

• ArnaDialog, on which ArnaAlertDialog is based.
• showArnaDialog, which actually displays the dialog and returns its result.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• ArnaAlertDialog

Constructors

ArnaAlertDialog({Key? key, String? title, Widget? content, List<Widget>? actions, String? semanticLabel, bool scrollable = false})

Creates an alert dialog.

const

Properties

actions → List<Widget>?

The (optional) set of actions that are displayed at the bottom of the dialog with an OverflowBar.

final

content → Widget?

The (optional) content of the dialog is displayed in the center of the dialog in a lighter font.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scrollable → bool

Determines whether the title and content widgets are wrapped in a scrollable.

final

semanticLabel → String?

The semantic label of the dialog used by accessibility frameworks to announce screen transitions when the dialog is opened and closed.

final

title → String?

The (optional) title of the dialog is displayed in a large font at the top of the dialog.

final

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

override

createElement() → StatelessElement

Creates a StatelessElement to manage this widget's location in the tree.

inherited

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}) → 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