CupertinoButton 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.
Preserves any parent IconThemeData but overwrites its IconThemeData.color with the CupertinoThemeData.primaryColor (or CupertinoThemeData.primaryContrastingColor if the button is disabled).
This sample shows produces an enabled and disabled CupertinoButton and
CupertinoButton.filled.
link
To create a local project with this code sample, run:
flutter create --sample=cupertino.CupertinoButton.1 mysample
See also:
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CupertinoButton
Constructors
-
CupertinoButton({Key? key, required Widget child, CupertinoButtonSize sizeStyle = CupertinoButtonSize.large, EdgeInsetsGeometry? padding, Color? color, Color disabledColor = CupertinoColors.quaternarySystemFill, double? minSize, double? pressedOpacity = 0.4, BorderRadius? borderRadius, AlignmentGeometry alignment = Alignment.center, Color? focusColor, FocusNode? focusNode, ValueChanged<
bool> ? onFocusChange, bool autofocus = false, VoidCallback? onLongPress, required VoidCallback? onPressed}) -
Creates an iOS-style button.
const
-
CupertinoButton.filled({Key? key, required Widget child, CupertinoButtonSize sizeStyle = CupertinoButtonSize.large, EdgeInsetsGeometry? padding, Color disabledColor = CupertinoColors.tertiarySystemFill, double? minSize, double? pressedOpacity = 0.4, BorderRadius? borderRadius, AlignmentGeometry alignment = Alignment.center, Color? focusColor, FocusNode? focusNode, ValueChanged<
bool> ? onFocusChange, bool autofocus = false, VoidCallback? onLongPress, required VoidCallback? onPressed}) -
Creates an iOS-style button with a filled background.
const
-
CupertinoButton.tinted({Key? key, required Widget child, CupertinoButtonSize sizeStyle = CupertinoButtonSize.large, EdgeInsetsGeometry? padding, Color? color, Color disabledColor = CupertinoColors.tertiarySystemFill, double? minSize, double? pressedOpacity = 0.4, BorderRadius? borderRadius, AlignmentGeometry alignment = Alignment.center, Color? focusColor, FocusNode? focusNode, ValueChanged<
bool> ? onFocusChange, bool autofocus = false, VoidCallback? onLongPress, required VoidCallback? onPressed}) -
Creates an iOS-style button with a tinted background.
const
Properties
- alignment → AlignmentGeometry
-
The alignment of the button's child.
final
- autofocus → bool
-
True if this widget will be selected as the initial focus when no other
node in its scope is currently focused.
final
- borderRadius → BorderRadius?
-
The radius of the button's corners when it has a background color.
final
- child → Widget
-
The widget below this widget in the tree.
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 onPressed or onLongPress to a non-null value.
no setter
- focusColor → Color?
-
The color to use for the focus highlight for keyboard interactions.
final
- focusNode → FocusNode?
-
An optional focus node to use as the focus node for this widget.
final
- 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
-
onFocusChange
→ ValueChanged<
bool> ? -
Handler called when the focus changes.
final
- onLongPress → VoidCallback?
-
If onPressed and onLongPress callbacks are null, then the button will be disabled.
final
- 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
- sizeStyle → CupertinoButtonSize
-
The size of the button.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CupertinoButton> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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.
override
-
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