React-Async-Button #

A button that handles Promises for your React app.

tl;dr #

• Install by executing npm install @wojtekmaj/react-async-button or yarn add @wojtekmaj/react-async-button.
• Use by adding import AsyncButton from '@wojtekmaj/react-async-button' and passing pendingConfig, successConfig.

Getting started #

Compatibility #

Your project needs to use React 16.8 or later.

React-Async-Button is also compatible with React Native.

Installation #

Add React-Async-Button to your project by executing npm install @wojtekmaj/react-async-button or yarn add @wojtekmaj/react-async-button.

Usage #

Here's an example of basic usage:

import React from 'react';
import AsyncButton from '@wojtekmaj/react-async-button';

const pendingConfig = {
  children: 'Loading…',
  disabled: true,
};

const successConfig = {
  children: 'Done',
};

const errorConfig = {
  children: 'Try again',
};

function MyComponent() {
  async function onClick(event) {
    // Do some async stuff
  }

  return (
    <AsyncButton
      onClick={onClick}
      pendingConfig={pendingConfig}
      successConfig={successConfig}
      errorConfig={errorConfig}
    >
      Do async stuff
    </AsyncButton>
  );
}

User guide #

AsyncButton #

Renders a button.

Props #

…and everything else a normal <button> would accept!

Accessibility #

For accessibility purposes, we recommend setting aria-live="polite" and aria-atomic="true" props so that button label changes are announced to the user using assitive technologies.

License #

The MIT License.

Author #

Wojciech Maj kontakt@wojtekmaj.pl https://wojtekmaj.pl