async_button 1.0.0-beta.1+1

Customized buttons for asyncronous onPressed function. Supports seamless animation between [idle], [loading], [success] and [failure] button states.

Buttons get boring when there is an asynchronous onTap function involved. Users don't get to see if or when the onTap function has finished execution, or if it has even finished sucessfully. To put it simply, this project aims to make them a little un-boring.

What is this?

This project provides you with the same buttons that you are used to, just with some modifications under the hood. You can manipulate the button state based on whether the onTap function is idle, loading or has finished loading(successfully or unsuccessfully).

How to use it?

This project provides you with 3 types of buttons. Let's list them below with an example.

AsyncElevatedButton

Just like ElevatedButton, but for async onPressed

AsyncElevatedButton(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  // * It is NOT mandatory to define [loadingStyle, successStyle, failureStyle]
  // * if you don't need it.

  // This should ideally be the button's loading state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  loadingStyle: AsyncButtonStateStyle(
    style: ElevatedButton.styleFrom(
      backgroundColor: Colors.amber,
    ),
    widget: const SizedBox.square(
      dimension: 24,
      child: CircularProgressIndicator(
        color: Colors.white,
      ),
    ),
  ),

  // This should ideally be the button's success state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  successStyle: AsyncButtonStateStyle(
    style: ElevatedButton.styleFrom(
      backgroundColor: Colors.green,
      foregroundColor: Colors.white,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.check),
        SizedBox(width: 4),
        Text('Success!')
      ],
    ),
  ),

  // This should ideally be the button's failure state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  failureStyle: AsyncButtonStateStyle(
    style: ElevatedButton.styleFrom(
      backgroundColor: Colors.red,
      foregroundColor: Colors.white,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.error),
        SizedBox(width: 4),
        Text('Error!'),
      ],
    ),
  ),
  child: const Text('Execute'),
);

Too much? You can make use of the following constructor instead. This has some pre-defined styles

AsyncElevatedButton.withDefaultStyles(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  child: const Text('Execute'),
);

AsyncTextButton

Just like TextButton, but for async onPressed

AsyncTextButton(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  // * It is NOT mandatory to define [loadingStyle, successStyle, failureStyle]
  // * if you don't need it.

  // This should ideally be the button's loading state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  loadingStyle: AsyncButtonStateStyle(
    style: TextButton.styleFrom(
      foregroundColor: Colors.amber,
    ),
    widget: const SizedBox.square(
      dimension: 24,
      child: CircularProgressIndicator(
        color: Colors.amber,
      ),
    ),
  ),


  // This should ideally be the button's success state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  successStyle: AsyncButtonStateStyle(
    style: TextButton.styleFrom(
      foregroundColor: Colors.green,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.check),
        SizedBox(width: 4),
        Text('Success!')
      ],
    ),
  ),

  // This should ideally be the button's failure state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  failureStyle: AsyncButtonStateStyle(
    style: TextButton.styleFrom(
      foregroundColor: Colors.red,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.error),
        SizedBox(width: 4),
        Text('Error!')
      ],
    ),
  ),
  child: const Text('Execute'),
);

Here again, you can use the following constructor which has some pre-defined styles

AsyncTextButton.withDefaultStyles(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  child: const Text('Execute'),
);

AsyncOutlinedButton

Just like OutlinedButton, but for async onPressed

AsyncOutlinedButton(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  // * It is NOT mandatory to define [loadingStyle, successStyle, failureStyle]
  // * if you don't need it.

  // This should ideally be the button's loading state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  loadingStyle: AsyncButtonStateStyle(
    style: OutlinedButton.styleFrom(
      foregroundColor: Colors.amber,
    ),
    widget: const SizedBox.square(
      dimension: 24,
      child: CircularProgressIndicator(
        color: Colors.amber,
      ),
    ),
  ),

  // This should ideally be the button's success state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  successStyle: AsyncButtonStateStyle(
    style: OutlinedButton.styleFrom(
      foregroundColor: Colors.green,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.check),
        SizedBox(width: 4),
        Text('Success!')
      ],
    ),
  ),

  // This should ideally be the button's failure state indicator.
  // If [style] or [widget] properties are not defined, we consider the button's
  // corresponding default [style] and [child] property
  failureStyle: AsyncButtonStateStyle(
    style: OutlinedButton.styleFrom(
      foregroundColor: Colors.red,
    ),
    widget: Row(
      mainAxisSize: MainAxisSize.min,
      children: const [
        Icon(Icons.error),
        SizedBox(width: 4),
        Text('Error!')
      ],
    ),
  ),
  child: const Text('Execute'),
);

Here as well, there is an alternative constructor with some pre-defined styles

AsyncOutlinedButton.withDefaultStyles(
  onPressed: (AsyncButtonStateController btnStateController) async {
    btnStateController.update(ButtonState.loading);
    try {
      // Await your api call here
      btnStateController.update(ButtonState.success);
    } catch (e) {
      btnStateController.update(ButtonState.failure);
    }
  },
  child: const Text('Execute'),
);

Similar Projects

If this library doesn't cater to your requirements. Here are the some similar projects you can explore:

• async_button_builder

  

• easy_loading_button

  

• animated_loading_button

  

Contribute

The creator always appreciates a helping hand, so don't hesitate before creating a pull request or reporting a bug/issue.

Connect with the Creator

The creator does aspire to help grow the flutter community. So if you have a question related to this project, your project, or anything flutter, connect with him over the following links. Don't worry, it's free!😉

LinkedIn

[e-mail]

Made with ❤️