# @alckor127/react-spinkit

> A collection of spinner indicators animated with SpinKit for React.

Latest version **1.0.0** (published 2020-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alckor127/react-spinkit
pnpm add @alckor127/react-spinkit
yarn add @alckor127/react-spinkit
bun add @alckor127/react-spinkit
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-12-03 |
| First published | 2020-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 100.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | alckor127 |
| Maintainers | alckor127 |
| Keywords | spinner, spinkit, spin, react, react-spinkit |

## Links

- npm: https://www.npmjs.com/package/@alckor127/react-spinkit
- Repository: https://github.com/alckor127/react-spinkit
- Homepage: https://github.com/alckor127/react-spinkit#readme
- Issues: https://github.com/alckor127/react-spinkit/issues
- npm.io page: https://npm.io/package/@alckor127/react-spinkit

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-12-03

## README

# react-spinkit

A collection of spinner indicators animated with SpinKit for React.

[![NPM](https://img.shields.io/npm/v/@alckor127/react-spinkit.svg)](https://www.npmjs.com/package/@alckor127/react-spinkit) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save @alckor127/react-spinkit
```

## Usage

```jsx
import React, { Component } from "react"

import SpinKit from "@alckor127/react-spinkit"
import "@alckor127/react-spinkit/dist/index.css"

class Example extends Component {
  render() {
    return <SpinKit />
  }
}
```

## API Reference

<a name="spinkit-component"></a>

### `<SpinKit />`

| Prop                   | Type   |    Default    | Description                                                                                                                     |
| :--------------------- | :----- | :-----------: | :------------------------------------------------------------------------------------------------------------------------------ |
| [`type`](#type-prop)   | String | `fade-circle` | Determine the style type of the spinner. Default value is `fade-circle`. Check all possible values [`here`](#type-prop-values). |
| [`size`](#size-prop)   | String |               | Determine the size of the spinner. Check all possible values [`here`](#size-prop-values).                                       |
| [`color`](#color-prop) | String |               | Determine the size of spinner. Check all possible values [`here`](#color-prop-values).                                          |

<a name="type-prop"></a>

#### Type

Determine the style type of the spinner. Default value is `fade-circle`.

```jsx
<SpinKit type='pulse' />
```

<a name="type-prop-values"></a>

##### All values

- circle
- double-bounce
- fade-circle
- flow
- fold-cube
- grid-cube
- grow
- pulse
- rotate-plane
- swing
- wave

<a name="type-prop"></a>

#### Size

Determine the size of the spinner.

```jsx
<SpinKit size='sm' />
```

<a name="size-prop-values"></a>

##### All values

- sm
- lg

<a name="color-prop"></a>

#### Color

Determine the color of the spinner.

```jsx
<SpinKit color='dark' />
```

<a name="color-prop-values"></a>

##### All values

- primary
- secondary
- success
- danger
- warning
- info
- light
- dark

## License

MIT © [alckor127](https://github.com/alckor127) 2020

---
_Source: https://npm.io/package/@alckor127/react-spinkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._