FloatingActionButtonModifier class

A Material Design floating action button.

A floating action button is a circular icon button that hovers over content to promote a primary action in the application. Floating action buttons are most commonly used in the Scaffold.floatingActionButton field.

Use at most a single floating action button per screen. Floating action buttons should be used for positive actions such as "create", "share", or "navigate". (If more than one floating action button is used within a Route, then make sure that each button has a unique heroTag, otherwise an exception will be thrown.)

If the onPressed callback is null, then the button will be disabled and will not react to touch. It is highly discouraged to disable a floating action button as there is no indication to the user that the button is disabled. Consider changing the backgroundColor if disabling the floating action button.

{@tool dartpad} This example shows how to display a FloatingActionButton in a Scaffold, with a pink backgroundColor and a thumbs up Icon.

** See code in examples/api/lib/material/floating_action_button/floating_action_button.0.dart ** {@end-tool}

{@tool dartpad} This example shows how to make an extended FloatingActionButton in a Scaffold, with a pink backgroundColor, a thumbs up Icon and a Text label that reads "Approve".

** See code in examples/api/lib/material/floating_action_button/floating_action_button.1.dart ** {@end-tool}

Material Design 3 introduced new types of floating action buttons. {@tool dartpad} This sample shows the creation of FloatingActionButton widget in the typical location in a Scaffold, as described in: https://m3.material.io/components/floating-action-button/overview

** See code in examples/api/lib/material/floating_action_button/floating_action_button.2.dart ** {@end-tool}

{@tool dartpad} This sample shows the creation of all the variants of FloatingActionButton widget as described in: https://m3.material.io/components/floating-action-button/overview

** See code in examples/api/lib/material/floating_action_button/floating_action_button.3.dart ** {@end-tool}

See also:

• Scaffold, in which floating action buttons typically live.
• ElevatedButton, a filled button whose material elevates when pressed.
• material.io/design/components/buttons-floating-action-button.html
• m3.material.io/components/floating-action-button

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• SingleChildStatelessModifier
• FloatingActionButtonModifier

Available extensions

• ModifierTransformer

Constructors

FloatingActionButtonModifier({Key? key, Widget? child, Key? modifierKey, String? tooltip, Color? foregroundColor, Color? backgroundColor, Color? focusColor, Color? hoverColor, Color? splashColor, Object? heroTag, double? elevation, double? focusElevation, double? hoverElevation, double? highlightElevation, double? disabledElevation, required VoidCallback? onPressed, MouseCursor? mouseCursor, bool mini = false, ShapeBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, MaterialTapTargetSize? materialTapTargetSize, bool isExtended = false, bool? enableFeedback})

Creates a circular floating action 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

backgroundColor → Color?

The button's background color.

final

clipBehavior → Clip

The content will be clipped (or not) according to this option.

final

disabledElevation → double?

The z-coordinate at which to place this button when the button is disabled (onPressed is null).

final

elevation → double?

The z-coordinate at which to place this button relative to its parent.

final

enableFeedback → bool?

Whether detected gestures should provide acoustic and/or haptic feedback.

final

extendedIconLabelSpacing → double?

The spacing between the icon and the label for an extended FloatingActionButton.

final

extendedPadding → EdgeInsetsGeometry?

The padding for an extended FloatingActionButton's content.

final

extendedTextStyle → TextStyle?

The text style for an extended FloatingActionButton's label.

final

focusColor → Color?

The color to use for filling the button when the button has input focus.

final

focusElevation → double?

The z-coordinate at which to place this button relative to its parent when the button has the input focus.

final

focusNode → FocusNode?

An optional focus node to use as the focus node for this widget.

final

foregroundColor → Color?

The default foreground color for icons and text within the button.

final

hashCode → int

The hash code for this object.

no setter, inherited

heroTag → Object?

The tag to apply to the button's Hero widget.

final

highlightElevation → double?

The z-coordinate at which to place this button relative to its parent when the user is touching the button.

final

hoverColor → Color?

The color to use for filling the button when the button has a pointer hovering over it.

final

hoverElevation → double?

The z-coordinate at which to place this button relative to its parent when the button is enabled and has a pointer hovering over it.

final

isExtended → bool

True if this is an "extended" floating action button.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

materialTapTargetSize → MaterialTapTargetSize?

Configures the minimum size of the tap target.

final

mini → bool

Controls the size of this button.

final

modifierKey → Key?

The actual key of the widget, which Modifier wrapped

final, inherited

mouseCursor → MouseCursor?

The cursor for a mouse pointer when it enters or is hovering over the button.

final

onPressed → VoidCallback?

The callback that is called when the button is tapped or otherwise activated.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shape → ShapeBorder?

The shape of the button's Material.

final

splashColor → Color?

The splash color for this FloatingActionButton's InkWell.

final

tooltip → String?

Text that describes the action that will occur when the button is pressed.

final

Methods

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

inherited

buildWithChild(BuildContext context, Widget? child) → Widget

A build method that receives an extra child parameter.

override

createElement() → SingleChildStatelessElement

Create a SingleChildStatelessElement

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

modified() → Modifier

Available on Widget, provided by the ModifierTransformer extension

Transform normal widget to Modifier

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

Static Methods

extended({Key? key, Widget? icon, Key? modifierKey, required Widget label, String? tooltip, Color? foregroundColor, Color? backgroundColor, Color? focusColor, Color? hoverColor, Object? heroTag, double? elevation, double? focusElevation, double? hoverElevation, Color? splashColor, double? highlightElevation, double? disabledElevation, required VoidCallback onPressed, MouseCursor mouseCursor = SystemMouseCursors.click, ShapeBorder? shape, bool isExtended = true, MaterialTapTargetSize? materialTapTargetSize, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, double? extendedIconLabelSpacing, EdgeInsetsGeometry? extendedPadding, TextStyle? extendedTextStyle, bool? enableFeedback}) → SingleChildModifier

Creates a wider StadiumBorder-shaped floating action button with an optional icon and a label.

large({Key? key, Widget? child, Key? modifierKey, String? tooltip, Color? foregroundColor, Color? backgroundColor, Color? focusColor, Color? hoverColor, Color? splashColor, Object? heroTag, double? elevation, double? focusElevation, double? hoverElevation, double? highlightElevation, double? disabledElevation, required VoidCallback onPressed, MouseCursor? mouseCursor, ShapeBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, MaterialTapTargetSize? materialTapTargetSize, bool? enableFeedback}) → SingleChildModifier

Creates a large circular floating action button.

small({Key? key, Widget? child, Key? modifierKey, String? tooltip, Color? foregroundColor, Color? backgroundColor, Color? focusColor, Color? hoverColor, Color? splashColor, Object? heroTag, required VoidCallback? onPressed, MouseCursor? mouseCursor, double? elevation, double? focusElevation, double? hoverElevation, double? highlightElevation, double? disabledElevation, ShapeBorder? shape, Clip clipBehavior = Clip.none, FocusNode? focusNode, bool autofocus = false, MaterialTapTargetSize? materialTapTargetSize, bool? enableFeedback, double? extendedIconLabelSpacing, EdgeInsetsGeometry? extendedPadding, TextStyle? extendedTextStyle}) → SingleChildModifier

Creates a small circular floating action button.