YaruOptionButton class

An OutlinedButton with a default size of 40x40.

For example, an option button with an arbitrary child widget:

YaruOptionButton(
  onPressed: () {},
  child: Icon(YaruIcons.search),
),

Or with a pre-made color disk:

YaruOptionButton.color(
  onPressed: () {},
  color: Theme.of(context).primaryColor,
),
Inheritance

Constructors

YaruOptionButton({Key? key, required VoidCallback? onPressed, FocusNode? focusNode, bool autofocus = false, ButtonStyle? style, required Widget child})
Creates a YaruOptionButton.
YaruOptionButton.color({Key? key, required VoidCallback? onPressed, FocusNode? focusNode, bool autofocus = false, ButtonStyle? style, required Color color})
Creates a YaruOptionButton with a color disk.

Properties

autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
finalinherited
child → Widget?
Typically the button's label.
finalinherited
clipBehavior → Clip?
The content will be clipped (or not) according to this option.
finalinherited
enabled → bool
Whether the button is enabled or disabled.
no setterinherited
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
iconAlignment → IconAlignment
Determines the alignment of the icon within the widgets such as:
finalinherited
isSemanticButton → bool?
Determine whether this subtree represents a button.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onFocusChange → ValueChanged<bool>?
Handler called when the focus changes.
finalinherited
onHover → ValueChanged<bool>?
Called when a pointer enters or exits the button response area.
finalinherited
onLongPress → VoidCallback?
Called when the button is long-pressed.
finalinherited
onPressed → VoidCallback?
Called when the button is tapped or otherwise activated.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statesController → MaterialStatesController?
Represents the interactive "state" of this widget in terms of a set of MaterialStates, like MaterialState.pressed and MaterialState.focused.
finalinherited
style → ButtonStyle?
Customizes this button's appearance.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ButtonStyleButton>
Creates the mutable state for this widget at a given 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.
inherited
defaultStyleOf(BuildContext context) → ButtonStyle
Defines the button's default appearance.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
themeStyleOf(BuildContext context) → ButtonStyle?
Returns the ButtonStyle that belongs to the button's component theme.
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