FutureButton<T> class

A StatefulWidget that handles any Future requests and displays different states (idle, loading, success, error) for a button. This is the parent/generic class that can handle any type of Future operation.

Inheritance
Implementers

Constructors

FutureButton({Key? key, required Future<T> requestFunction(), required void onSuccess(T response), bool isReady() = _defaultIsReady, bool responseValidator(T response)?, Widget? successWidget, Widget? loadingWidget, Widget? errorWidget, Widget? idleNotReadyWidget, required Widget idleWidget(ButtonStyle style), required ButtonStyle buttonStyle})
Creates an instance of FutureButton.
const

Properties

buttonStyle → ButtonStyle
Style for the button.
final
errorWidget → Widget?
Widget to show when an error occurs.
final
hashCode → int
The hash code for this object.
no setterinherited
idleNotReadyWidget → Widget?
Widget to show when not ready.
final
idleWidget → Widget Function(ButtonStyle style)
Initial widget before any action (idle state).
final
isReady → bool Function()
Function to check if the button is ready to be pressed.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingWidget → Widget?
Widget to show while loading.
final
onSuccess → void Function(T response)
Callback for when the request is successful.
final
requestFunction → Future<T> Function()
Function to make the Future request.
final
responseValidator → bool Function(T response)?
Function to validate the response (optional).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
successWidget → Widget?
Widget to show on success.
final

Methods

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