CNButton class

A Cupertino-native push button.

Embeds a native UIButton/NSButton for authentic visuals and behavior on iOS and macOS. Falls back to CupertinoButton on other platforms.

Inheritance

Constructors

CNButton.new({Key? key, required String? label, VoidCallback? onPressed, bool enabled = true, Color? tint, double height = 32.0, bool shrinkWrap = false, CNButtonStyle style = CNButtonStyle.plain})
Creates a text button variant of CNButton.
const
CNButton.icon({Key? key, required CNSymbol? icon, VoidCallback? onPressed, bool enabled = true, Color? tint, double size = 44.0, CNButtonStyle style = CNButtonStyle.glass})
Creates a round, icon-only variant of CNButton.
const

Properties

enabled bool
Whether the control is interactive and tappable.
final
hashCode int
The hash code for this object.
no setterinherited
height double
Control height.
final
icon CNSymbol?
Button icon (non-null in icon mode).
final
isIcon bool
Whether this instance is configured as the icon variant.
no setter
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label String?
Button text (null in icon mode).
final
onPressed VoidCallback?
Callback when pressed.
final
round bool
Whether the icon variant (round) is used.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shrinkWrap bool
If true, sizes the control to its intrinsic width.
final
style CNButtonStyle
Visual style to apply.
final
tint Color?
Accent/tint color.
final
width double?
Fixed width used in icon/round mode.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<CNButton>
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.
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