npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wojtekmaj/react-async-button

v1.6.0

Published

A button that handles Promises for your React app.

Downloads

2,033

Readme

npm downloads CI

@wojtekmaj/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 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>
  );
}

Usage with React Native

AsyncButton renders <button> by default, but by passing as prop you can render any component you want. Here's the same example, but using <TouchableOpacity> instead of <button>:

import { TouchableOpacity } from 'react-native';
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
      as={TouchableOpacity}
      onClick={onClick}
      pendingConfig={pendingConfig}
      successConfig={successConfig}
      errorConfig={errorConfig}
    >
      Do async stuff
    </AsyncButton>
  );
}

User guide

AsyncButton

Renders a button.

Props

| Prop name | Description | Default value | Example values | | ------------- | --------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------- | | as | Component to render button with. | "button" | String: "custom-button"React component: MyButton | | errorConfig | Props to override default props with when onClick async function throws. | {} | { children: 'Try again' } | | onClick | A function, a function returning a Promise, or an async function to be called when the button is clicked. | n/a | | | pendingConfig | Props to override default props when button has been clicked but onClick function did not yet resolve. | {} | { children: 'Loading…' } | | resetTimeout | Time in milliseconds after which AsyncButton should stop using errorConfig / successConfig overrides. | 2000 | 5000 | | successConfig | Props to override default props with when onClick async function resolves. | {} | { children: 'Done' } |

…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