CloseButton class

A Material Design close icon button.

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

The onPressed callback can, for instance, be used to pop the platform's navigation stack via SystemNavigator instead of Flutter's Navigator in add-to-app situations.

In Material Design 3, both style's ButtonStyle.iconColor and color are used to override the default icon color of CloseButton. If both exist, the ButtonStyle.iconColor will override color for states where ButtonStyle.foregroundColor resolves to non-null.

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, ButtonStyle? style})
Creates a Material Design close icon button.
const

Properties

alignment → AlignmentGeometry?
Defines how the icon is positioned within the IconButton.
finalinherited
autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
finalinherited
color → Color?
The color to use for the icon inside the button, if the icon is enabled. Defaults to leaving this up to the icon widget.
finalinherited
constraints → BoxConstraints?
Optional size constraints for the button.
finalinherited
disabledColor → Color?
The color to use for the icon inside the button, if the icon is disabled. Defaults to the ThemeData.disabledColor of the current Theme.
finalinherited
enableFeedback → bool?
Whether detected gestures should provide acoustic and/or haptic feedback.
finalinherited
focusColor → Color?
The color for the button when it has the input focus.
finalinherited
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
highlightColor → Color?
The secondary color of the button when the button is in the down (pressed) state. The highlight color is represented as a solid color that is overlaid over the button color (if any). If the highlight color has transparency, the button color will show through. The highlight fades in quickly as the button is held down.
finalinherited
hoverColor → Color?
The color for the button when a pointer is hovering over it.
finalinherited
icon → Widget
The icon to display inside the button.
finalinherited
iconSize → double?
The size of the icon inside the button.
finalinherited
isSelected → bool?
The optional selection state of the icon button.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the button.
finalinherited
onHover → ValueChanged<bool>?
The callback that is called when the button is hovered.
finalinherited
onLongPress → VoidCallback?
The callback that is called when the button is long-pressed.
finalinherited
onPressed → VoidCallback?
The callback that is called when the button is tapped or otherwise activated.
finalinherited
padding → EdgeInsetsGeometry?
The padding around the button's icon. The entire padded icon will react to input gestures.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedIcon → Widget?
The icon to display inside the button when isSelected is true. This property can be null. The original icon will be used for both selected and unselected status if it is null.
finalinherited
splashColor → Color?
The primary color of the button when the button is in the down (pressed) state. The splash is represented as a circular overlay that appears above the highlightColor overlay. The splash overlay has a center point that matches the hit point of the user touch event. The splash overlay will expand to fill the button area if the touch is held for long enough time. If the splash color has transparency then the highlight and button color will show through.
finalinherited
splashRadius → double?
The splash radius.
finalinherited
standardComponent → StandardComponentType?
An enum value to use to identify this button as a type of StandardComponentType.
finalinherited
style → ButtonStyle?
Customizes this button's appearance.
finalinherited
tooltip → String?
Text that describes the action that will occur when the button is pressed.
finalinherited
visualDensity → VisualDensity?
Defines how compact the icon button's layout will be.
finalinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
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, int wrapWidth = 65}) → 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