CupertinoButtonModifier class

An iOS-style button.

Takes in a text or an icon that fades out and in on touch. May optionally have a background.

The padding defaults to 16.0 pixels. When using a CupertinoButton within a fixed height parent, like a CupertinoNavigationBar, a smaller, or even EdgeInsets.zero, should be used to prevent clipping larger child widgets.

{@tool dartpad} This sample shows produces an enabled and disabled CupertinoButton and CupertinoButton.filled.

** See code in examples/api/lib/cupertino/button/cupertino_button.0.dart ** {@end-tool}

See also:

Inheritance
Available extensions

Constructors

CupertinoButtonModifier({Key? key, Widget? child, Key? modifierKey, EdgeInsetsGeometry? padding, Color? color, Color disabledColor = CupertinoColors.quaternarySystemFill, double? minSize = kMinInteractiveDimensionCupertino, double? pressedOpacity = 0.4, BorderRadius? borderRadius = const BorderRadius.all(Radius.circular(8.0)), AlignmentGeometry alignment = Alignment.center, required VoidCallback? onPressed})
Creates an iOS-style button.
const
CupertinoButtonModifier.filled({Key? key, Widget? child, EdgeInsetsGeometry? padding, Color disabledColor = CupertinoColors.quaternarySystemFill, double? minSize = kMinInteractiveDimensionCupertino, double? pressedOpacity = 0.4, BorderRadius? borderRadius = const BorderRadius.all(Radius.circular(8.0)), AlignmentGeometry alignment = Alignment.center, required VoidCallback? onPressed})
Creates an iOS-style button with a filled background.
const

Properties

alignment → AlignmentGeometry
The alignment of the button's child.
final
borderRadius → BorderRadius?
The radius of the button's corners when it has a background color.
final
color → Color?
The color of the button's background.
final
disabledColor → Color
The color of the button's background when the button is disabled.
final
enabled → bool
Whether the button is enabled or disabled. Buttons are disabled by default. To enable a button, set its onPressed property to a non-null value.
no setter
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
minSize → double?
Minimum size of the button.
final
modifierKey → Key?
The actual key of the widget, which Modifier wrapped
finalinherited
onPressed → VoidCallback?
The callback that is called when the button is tapped or otherwise activated.
final
padding → EdgeInsetsGeometry?
The amount of space to surround the child inside the bounds of the button.
final
pressedOpacity → double?
The opacity that the button will fade to when it is pressed. The button will have an opacity of 1.0 when it is not pressed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) → Widget
A build method that receives an extra child parameter.
override
createElement() → SingleChildStatelessElement
Create a SingleChildStatelessElement
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
modified() → Modifier

Available on Widget, provided by the ModifierTransformer extension

Transform normal widget to Modifier
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