ToggleButton class

A button that can be on or off.

See also:

  • Checkbox, which is used to select or deselect action items
  • ToggleSwitch, which use used to turn things on and off
Inheritance
Available Extensions

Constructors

ToggleButton({Key? key, required bool checked, required ValueChanged<bool>? onChanged, Widget? child, ToggleButtonThemeData? style, String? semanticLabel, FocusNode? focusNode, bool autofocus = false})
Creates a toggle button.
const

Properties

autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
checked → bool
Whether this ToggleButton is checked
final
child → Widget?
The content of the button
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
onChanged → ValueChanged<bool>?
Whenever the value of this ToggleButton should change
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticLabel → String?
The semantics label of the button
final
style → ToggleButtonThemeData?
The style of the button. This style is merged with FluentThemeData.toggleButtonThemeData
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
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.
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}) → 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