SFutureButton class

A customizable button widget that handles asynchronous operations with automatic loading states.

The onTap callback returns a Future<bool?> to control the button's behavior:

  • Returns true or completes successfully: Shows success animation
  • Returns false: Shows error state with 'Validation failed' message
  • Returns null: Resets button without showing success animation (silent dismissal)
  • Throws exception: Shows error state with the exception message

Example usage:

SFutureButton(
  onTap: () async {
    // Perform validation
    if (someCondition) return null; // Dismiss without success
    if (!isValid) return false; // Show error

    // Perform the actual operation
    await someAsyncOperation();
    return true; // Show success animation
  },
  onPostSuccess: () {
    // Called only when onTap returns true
    print('Operation completed successfully');
  },
)
Inheritance
Available extensions

Constructors

SFutureButton({Key? key, Future<bool?> onTap()?, String? label, Widget? icon, double? height, double? width, bool isEnabled = true, bool isElevatedButton = true, bool showErrorMessage = true, Color? bgColor, Color? iconColor, double? borderRadius, ValueChanged<String>? onPostError, VoidCallback? onPostSuccess, FocusNode? focusNode, void onFocusChange(bool)?, double? loadingCircleSize, Duration? successDuration, Duration? errorDuration, Widget? loadingWidget})
const

Properties

bgColor → Color?
final
borderRadius → double?
final
errorDuration → Duration?
Duration to display the error state before resetting. Defaults to 1500ms.
final
focusNode → FocusNode?
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
final
icon → Widget?
final
iconColor → Color?
final
isElevatedButton → bool
final
isEnabled → bool
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
final
loadingCircleSize → double?
final
loadingWidget → Widget?
Custom widget to display while loading. Replaces the default circular progress indicator inside the button.
final
onFocusChange → void Function(bool)?
final
onPostError → ValueChanged<String>?
final
onPostSuccess → VoidCallback?
final
onTap → Future<bool?> Function()?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showErrorMessage → bool
final
successDuration → Duration?
Duration to display the success state before resetting. Defaults to 400ms.
final
width → double?
final

Methods

addMaterialWidget() → Material

Available on Widget, provided by the GenericExtensions extension

addTooltipWidget(String toolTip) → Tooltip

Available on Widget, provided by the GenericExtensions extension

borderRadius([BorderRadiusGeometry? borderRadius]) → Widget

Available on Widget, provided by the GenericExtensions extension

boxDecoration([BoxDecoration? boxDecoration]) → Widget

Available on Widget, provided by the GenericExtensions extension

colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

set parent widget in center
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SFutureButton>
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