Button class
A button gives the user a way to trigger an immediate action
See also:
- IconButton. A button but with an icon
- ToggleButton. A button that can be on or off
- HoverButton. A base widget to implement any input fluent-like input
- Inheritance
Constructors
- Button({Key? key, Widget? child, ButtonStateWidgetBuilder? builder, ButtonThemeData? style, VoidCallback? onPressed, VoidCallback? onLongPress, String? semanticLabel, FocusNode? focusNode, bool autofocus = false})
-
Creates a fluent-styled button.
const
- Button.icon({Key? key, required Widget icon, ButtonThemeData? style, IconThemeButtonStateBuilder? iconTheme, VoidCallback? onPressed, VoidCallback? onLongPress, String? semanticLabel, FocusNode? focusNode, bool autofocus = false})
- Creates a button with an icon. Uses IconButton under the hood
-
Button.toggle({Key? key, required bool checked, required ValueChanged<
bool> onChanged, Widget? child, ToggleButtonThemeData? style, FocusNode? focusNode, bool autofocus = false, String? semanticLabel}) - Creates a button that can be on or of. Uses a ToggleButton under the hood
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
- builder → ButtonStateWidgetBuilder?
-
Build the button according to its current state.
final
- child → Widget?
-
The content of the button. Usually a Text widget.
final
- enabled → bool
-
Whether the button is enabled or not.
no setter
- 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
- onLongPress → VoidCallback?
-
Callback to when the button gets pressed for a long time.
final
- onPressed → VoidCallback?
-
Callback to when the button get pressed.
If
null
, the button will be considered disabledfinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
Semantic label for the input.
final
- style → ButtonThemeData?
-
The style of the button. If non-null, it's mescled with
ThemeData.buttonThemeData
final - type → _ButtonType
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ButtonState -
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}) → 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