# the-spin

> Spin of the-components

Latest version **3.1.12** (published 2018-11-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install the-spin
pnpm add the-spin
yarn add the-spin
bun add the-spin
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.1.12 |
| Published | 2018-11-23 |
| First published | 2017-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 6 |
| Unpacked size | 61.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | react-component, the |

## Links

- npm: https://www.npmjs.com/package/the-spin
- Repository: https://github.com/the-labo/the-spin
- Homepage: https://github.com/the-labo/the-spin#readme
- Issues: https://github.com/the-labo/the-spin/issues
- npm.io page: https://npm.io/package/the-spin

## Dependencies (6)

- [asobj](https://npm.io/package/asobj.md) ^3.0.0
- [the-icon](https://npm.io/package/the-icon.md) ^4.0.10
- [the-style](https://npm.io/package/the-style.md) ^2.2.3
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.2
- [the-component-util](https://npm.io/package/the-component-util.md) ^3.0.20

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 3.1.12 (latest) — 2018-11-23
- 3.1.11 — 2018-11-17
- 3.1.10 — 2018-08-24
- 3.1.9 — 2018-08-09
- 3.1.8 — 2018-08-09
- 3.1.7 — 2018-06-22
- 3.1.6 — 2018-06-18
- 3.1.5 — 2018-06-18
- 3.1.4 — 2018-06-18
- 3.1.3 — 2018-06-18
- 3.1.2 — 2018-06-17
- 3.1.1 — 2018-06-17
- 3.1.0 — 2018-01-13
- 3.0.0 — 2018-01-09
- 2.0.0 — 2017-09-29
- … 4 more at https://npm.io/package/the-spin/versions

## README

the-spin
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-spin
[bd_travis_url]: http://travis-ci.org/the-labo/the-spin
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-spin.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-spin
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-spin.svg?token=
[bd_license_url]: https://github.com/the-labo/the-spin/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-spin
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-spin.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Spin of the-components

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-spin --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

[Live Demo](https://the-labo.github.io/the-spin/doc/demo/index.html#/) is hosted on GitHub Page

```javascript
'use strict'

import React from 'react'
import { TheSpin, TheSpinStyle } from 'the-spin'

class ExampleComponent extends React.PureComponent {
  render () {
    let spinStyle = {width: 120, height: 180, display: 'inline-block'}
    return (
      <div>
        <TheSpinStyle/>
        <span style={spinStyle}><TheSpin size='xx-large' theme='A' enabled={true}/></span>
        <span style={spinStyle}><TheSpin size='xx-large' theme='B' enabled={true}/></span>
        <span style={spinStyle}><TheSpin size='xx-large' theme='C' enabled={true}/></span>
        <span style={spinStyle}><TheSpin size='xx-large' theme='D' enabled={true}/></span>
        <span style={spinStyle}><TheSpin size='xx-large' theme='E' enabled={true}/></span>
        <span style={spinStyle}><TheSpin size='xx-large' theme='F' enabled={true}/></span>

        <br/>

        <div style={{width: 120, height: 120, position: 'relative'}}>
          Show spinner as cover
          <TheSpin cover enabled/>
        </div>
        <br/>
        <div style={
          {display: 'block', overflowX: 'auto', height: '32px', whiteSpace: 'nowrap', paddingBottom: 16}
        }>
          {
            new Array(72).fill(0).map((_, i) => (
              <span key={i} style={{display: 'inline-block', width: '32px', height: '32px'}}>
              <TheSpin enabled={true} size='small'/>
                </span>
            ))
          }
        </div>
      </div>

    )
  }
}

export default ExampleComponent

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Components.md.hbs" Start -->

<a name="section-doc-guides-03-components-md"></a>

Components
-----------

### TheSpin

Spin of the-components

**Props**

| Name | Type | Description | Default |
| --- | --- | ---- | ---- |
| `cover` | bool  | show as cover | `false` |
| `enabled` | bool  |  | `false` |
| `size` | enum  | Size of spinner icon | `'large'` |
| `theme` | enum  | Theme of the spinner | `'C'` |

### TheSpinStyle

Style for TheSpin

**Props**

| Name | Type | Description | Default |
| --- | --- | ---- | ---- |
| `options` | object  | Style options | `{}` |



<!-- Section from "doc/guides/03.Components.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-spin/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

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