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

react-redux-spinner

v3.0.0

Published

A spinner and loading bar for any long running tasks. For react with redux

Downloads

2,300

Readme

React Redux Spinner

A simple spinner for any "long" running tasks (such as fetching data off a server).

Demo of spinner functionality

DEMO: https://storytel.github.io/react-redux-spinner

Installation

npm install react-redux-spinner --save

Usage

Import the library.

import {
  Spinner, // The React component
  pendingTasksReducer, // The redux reducer
  pendingTask, // The action key for modifying loading state
  begin, // The action value if a "long" running task begun
  end, // The action value if a "long" running task ended
  endAll // The action value if all running tasks must end
} from 'react-redux-spinner';

Install the reducer to the store. Make sure it reduces the pendingTasks key. This is best done using combineReducers from redux.

import { createStore, combineReducers } from 'redux'
const reducer = combineReducers({
  pendingTasks: pendingTasksReducer
});

const store = createStore(reducer);

Put the Spinner component anywhere in your application.

import React from 'react';
const App extends React.Component {
  render() {
    return (<Spinner />)
  }
}

Start a long running task. This will typically be when you begin fetching data from a server.

This will increase the pending tasks counter by 1. The spinner will be shown when the pending tasks is greater than 0.

store.dispatch({
  type: 'ANY_OF_YOUR_ACTION_TYPES'
  [ pendingTask ]: begin // Make sure you embrace `pendingTask` in brackets [] to evaluate it
  // Any additional key/values may be included here
});

When your long running task is done.

store.dispatch({
  type: 'ANY_OF_YOUR_ACTION_TYPES_DONE'
  [ pendingTask ]: end // Bracket [] embrace, remember?
  // Any additional key/values may be included here
});

When you want to force the finish of all pending tasks (for example: with a global error).

store.dispatch({
  type: 'ANY_OF_YOUR_ACTION_TYPES_FINISH'
  [ pendingTask ]: endAll // Bracket [] embrace, remember?
  // Any additional key/values may be included here
});

CSS

By default, no styling is included. You can either roll your own. Feel free to use the default css as boilerplate.

If you're using webpack as your bundler, you could use style-loader and css-loader to include the default css.

In webpack.config.js:

  // ...
  module: {
    rules: {
      {
        test: /\.css$/,
        loader: 'style-loader!css-loader'
      }
    }
  }

and in your css files (the tilde ~ means "look in node_modules"):

@import '~react-redux-spinner/dist/react-redux-spinner.css';

Configurable reducer

Maybe you cannot have the pendingTask in the root of your actions. For instance, if you're trying to follow the Flux Standard Actions you're not allowed to have anything in the root except type, payload, error and meta. It would then be prudent to put pendingTask in meta. To get the reducer to look here instead you need to configure it to do so with configurablePendingTasksReducer.

import { configurablePendingTasksReducer } from 'react-redux-spinner';
import { createStore, combineReducers } from 'redux'
const pendingTasks = configurablePendingTasksReducer({ actionKeyPath: [ 'meta' ] });
const reducer = combineReducers({
  pendingTasks: pendingTasksReducer
});
const store = createStore(reducer);

and then dispatch actions:

store.dispatch({
  type: 'ANY_OF_YOUR_ACTION_TYPES'
  meta: {
    [ pendingTask ]: begin
  }
});

The actionKeyPath may be as deeply nested as required. For instance, if you'd like to have the keys in meta.async, you'd provide actionKeyPath: [ 'meta', 'async' ] and then dispatch actions with { meta: { async: { [ pendingTask ]: begin } } }

Pro-tips

  • Don't want to bloat your namespace with begin or end variables?
import rrs from 'react-redux-spinner';

dispatch({
  type: 'ACTION_TYPE',
  [ rrs.pendingTask ]: rrs.begin
});
import { pendingTasksReducer as pendingTasks } from 'react-redux-spinner';
const reducer = combineReducers({ pendingTasks });
  • Modify the appearance of the spinners (example modifies the color, but any css attributes can be set)
#nprogress .bar {
  background-color: #f4590a;
}

#nprogress .spinner-icon {
  border-top-color: #f4590a;
  border-left-color: #f4590a;
}

#nprogress .peg {
  box-shadow: 0 0 10px #f4590a, 0 0 5px #f4590a;
}
  • Modify the configuration of the spinners (example modifies the tricklerate, for all possible changes see https://github.com/rstacruz/nprogress#configuration)
  render() {
    return (<Spinner config={{ trickleRate: 0.02 }} />)
  }