Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 2.5 KB

README.md

File metadata and controls

133 lines (93 loc) · 2.5 KB
Raw

Respinner

npm-version

react components for spinners or loaders. Each loader was combined css animation and render dom as svg. easily controlled by react porps.

You could change the count of spinner's children by props count, also the color of themselves. All of them built with SVG, so you can easily scale them with width and height.

Examples

demo

See more details in demo directory or visit website

Usage

npm install --save respinner

Just import it when use with react. Issues go to issues.

Basic

import React from 'react'
import {
  BeatLoading, BounceLoading, CircularLoading,
  ClockLoading, RotateLoading, SpinLoading,
  WaveLoading, DashLoading, CopperLoading
} from 'respinner'

function LoadingComponents() {
  <div className="spinners">
    <SpinLoading fill="#777" borderRadius={4} count={12} /> // use with customized props
    <CircularLoading /> // or just use with default props
  </div>
}

Use with SVG use

// pre-define a spinner
<SpinLoading borderRadius={2} count={10} id="spin" />

// reuse them
<svg width="40"><use href="#spin" fill="#fff" /></svg>
<svg width="40"><use href="#spin" fill="#fff" /></svg>

API

Any SVG props could be used in these components. The following are the default props for these components:

1. BeatLoading

  • gap: 6
  • size: 8
  • count: 6
  • duration: 0.8

2. CircularLoading

  • size: 40
  • strokeWidth: 4
  • linecap: 'round'

3. BounceLoading

  • gap: 6
  • count: 4
  • barWidth: 4
  • barHeight: 16
  • duration: 0.8

4. RotateLoading

  • size: 40
  • opacity: 0.2
  • strokeWidth: 4

5. SpinLoading

  • size: 40
  • count: 8
  • barWidth: 4
  • duration: 1
  • barHeight: 10
  • borderRadius: 1

6. WaveLoading

  • size: 40
  • count: 3
  • duration: 1.5
  • strokeWidth: 2

7. ClockLoading

  • size: 40
  • duration: 2
  • strokeWidth: 2

8. DashLoading

  • size: 40
  • duration: 1.8
  • strokeWidth: 4

9. CopperLoading

  • size: 40
  • strokeWidth: 4

Development

pnpm install
pnpm dev

# see demo in http://localhost:3000

Build

pnpm run build # build lib
pnpm run build:docs # build docs

License

MIT