ApiButton<h> class
A specialized button that handles API requests and displays different states. This extends the generic FutureButton and adds API-specific functionality.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FutureButton<
h> - ApiButton
Constructors
-
ApiButton({Key? key, required Future<
h> requestFunction(), required void onSuccess(h response), Widget? successWidget, Widget? loadingWidget, Widget? errorWidget, bool isReady() = _defaultIsReady, Widget? idleNotReadyWidget, required Widget idleWidget(ButtonStyle style), required ButtonStyle buttonStyle}) - Creates an instance of ApiButton.
Properties
-
Style for the button.
finalinherited
- errorWidget → Widget?
-
Widget to show when an error occurs.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- idleNotReadyWidget → Widget?
-
Widget to show when not ready.
finalinherited
- idleWidget → Widget Function(ButtonStyle style)
-
Initial widget before any action (idle state).
finalinherited
- isReady → bool Function()
-
Function to check if the button is ready to be pressed.
finalinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingWidget → Widget?
-
Widget to show while loading.
finalinherited
- onSuccess → void Function(h response)
-
Callback for when the request is successful.
finalinherited
-
requestFunction
→ Future<
h> Function() -
Function to make the Future request.
finalinherited
- responseValidator → bool Function(h response)?
-
Function to validate the response (optional).
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- successWidget → Widget?
-
Widget to show on success.
finalinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< FutureButton< h> > -
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
-
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