CloseButton class

A material design close button.

A CloseButton is an IconButton with a "close" icon. When pressed, the close button calls Navigator.maybePop to return to the previous route.

Use a CloseButton instead of a BackButton on fullscreen dialogs or pages that may solicit additional actions to close.

See also:

  • AppBar, which automatically uses a CloseButton in its AppBar.leading slot when appropriate.
  • BackButton, which is more appropriate for middle nodes in the navigation tree or where pages can be popped instantaneously with no user data consequence.
  • IconButton, to create other material design icon buttons.
Inheritance

Constructors

CloseButton({Key key, Color color, VoidCallback onPressed})
Creates a Material Design close button.
const

Properties

color → Color
The color to use for the icon. [...]
final
hashCode → int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key → Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
onPressed → VoidCallback
An override callback to perform instead of the default behavior which is to pop the Navigator. [...]
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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
Returns 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. [...]
@nonVirtual, inherited