CupertinoCheckbox class
A macOS style checkbox.
The checkbox itself does not maintain any state. Instead, when the state of the checkbox changes, the widget calls the onChanged callback. Most widgets that use a checkbox will listen for the onChanged callback and rebuild the checkbox with a new value to update the visual appearance of the checkbox.
The checkbox can optionally display three values - true, false, and null - if tristate is true. When value is null a dash is displayed. By default tristate is false and the checkbox's value must be true or false.
In the Apple Human Interface Guidelines (HIG), checkboxes are encouraged for use on macOS, but is silent about their use on iOS. If a multi-selection component is needed on iOS, the HIG encourages the developer to use switches (CupertinoSwitch in Flutter) instead, or to find a creative custom solution.
This example shows a toggleable CupertinoCheckbox.
link
To create a local project with this code sample, run:
flutter create --sample=cupertino.CupertinoCheckbox.1 mysample
See also:
- Checkbox, the Material Design equivalent.
- CupertinoSwitch, a widget with semantics similar to CupertinoCheckbox.
- CupertinoSlider, for selecting a value in a range.
- developer.apple.com/design/human-interface-guidelines/components/selection-and-input/toggles/
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CupertinoCheckbox
Constructors
-
CupertinoCheckbox({Key? key, required bool? value, bool tristate = false, required ValueChanged<
bool?> ? onChanged, MouseCursor? mouseCursor, Color? activeColor, @Deprecated('Use fillColor instead. ' 'fillColor now manages the background color in all states. ' 'This feature was deprecated after v3.24.0-0.2.pre.') Color? inactiveColor, WidgetStateProperty<Color?> ? fillColor, Color? checkColor, Color? focusColor, FocusNode? focusNode, bool autofocus = false, BorderSide? side, OutlinedBorder? shape, String? semanticLabel}) -
Creates a macOS-styled checkbox.
const
Properties
- activeColor → Color?
-
The color to use when this checkbox is checked.
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
- checkColor → Color?
-
The color to use for the check icon when this checkbox is checked.
final
-
fillColor
→ WidgetStateProperty<
Color?> ? -
The color used to fill this checkbox.
final
- focusColor → Color?
-
The color for the checkbox's border shadow when it has the input focus.
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
- inactiveColor → Color?
-
The color used if the checkbox is inactive.
final
- 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
widget.
final
-
onChanged
→ ValueChanged<
bool?> ? -
Called when the value of the checkbox should change.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
The semantic label for the checkbox that will be announced by screen readers.
final
- shape → OutlinedBorder?
-
The shape of the checkbox.
final
- side → BorderSide?
-
The color and width of the checkbox's border.
final
- tristate → bool
-
If true, the checkbox's value can be true, false, or null.
final
- value → bool?
-
Whether this checkbox is checked.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CupertinoCheckbox> -
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