1.0.4 • Published 4 years ago

react-element-spinner v1.0.4

Weekly downloads
131
License
MIT
Repository
github
Last release
4 years ago

React element spinner

A customizable loading spinner for React that overlays divs and blocks buttons.

Demo

There is a demo with some examples here. The repo with the code is this one.

Quick start

This code would create a global spinner, it would block all the page.

import { SpinnerComponent } from 'react-element-spinner';

<SpinnerComponent loading={true} position="global" />

global

This code would create a spinner that blocks the form.

import { SpinnerComponent } from 'react-element-spinner';

<form>
    <SpinnerComponent loading={true} position="centered" />
    <input type="text" name="address"/>
    <button>SAVE</button>
</form>

This code would create a spinner that blocks the button.

import { SpinnerComponent } from 'react-element-spinner';

<button>
  Button
  <SpinnerComponent loading={true} position="inline" color="#498DFF"/>
</button>

elements

Properties

NameTypeRequiredDefaultDescription
loadingbooleantrue-Whether the spinner has to be shown or not.
positionstringtrue-Position of the spinner: "global" for all the page, "centered" to overlay a div and "inline" to be next to the content (for example a button).
colorstringfalse#3578e5Color of the spinner
secondaryColorstringfalse#f3f3f3Secondary color of the default spinner.
backgroundColorstringfalse#d3d3d3Color of the background div (only for "centered" and "global").
resizebooleanfalsefalseWhether to resize the overlay div or not when dimensions change (only for "centered").
spinnerTypestringfalse"default"Choose one of the three available spinners: "default", "circle-dots" or "circle-dots-collapse".
customSpinnerReactElementfalseundefinedCustom spinner to use instead of the default ones.
messagestringfalseundefinedMessage to show under the spinner.

Custom styling

The spinner component is easily customizable by overriding its css classes.

ClassElement
loader-containerThe main div.
loaderThe spinner div.
backgroundThe background div.
spanThe message.