# spinn

> SVG spinner loader

Latest version **0.1.6** (published 2023-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install spinn
pnpm add spinn
yarn add spinn
bun add spinn
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2023-01-12 |
| First published | 2023-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Vidar Eldøy |
| Maintainers | eldoy |

## Links

- npm: https://www.npmjs.com/package/spinn
- Repository: https://github.com/eldoy/spinn
- Homepage: https://github.com/eldoy/spinn#readme
- Issues: https://github.com/eldoy/spinn/issues
- npm.io page: https://npm.io/package/spinn

## Recent versions

- 0.1.6 (latest) — 2023-01-12
- 0.1.5 — 2023-01-12
- 0.1.4 — 2023-01-12
- 0.1.3 — 2023-01-12
- 0.1.2 — 2023-01-12
- 0.1.1 — 2023-01-12
- 0.1.0 — 2023-01-12

## README

# Spinn

SVG spinner loader. Very cool animated spinner with settings:

* Color
* Background color
* Size

Created by [Eldøy Projects →](https://eldoy.com)

### Install
```
npm i spinn
```

### Usage

**Server side rendered**

Require lib:
```js
const spinn = require('spinn')
```

Include on web page:
```
<script>${spinn}</spinn>
```

**Client side rendered**

Include `dist/spinn-min.js`:

```html
<script src="spinn-min.js"></script>
```

Create an element where the spinner should appear:

```
<spinn></spinn>
```

Use on page, include in `<script>` tag:
```js
// Create spinner, showing default options
var spinner = spinn({
  // Where to insert the spinner
  el: 'spinn',

  // The color of the spinner
  color: 'tomato',

  // Background color
  bg: 'transparent',

  // Size in pixels (width and height)
  size: 20
})

// Start spinner
spinner.start()

// Stop spinner
spinner.stop()

// Stop spinner via element
spin({ el: 'spin' }).stop()

// Short cut, using default options
var spinner = spinn().start()

// Stop after 5 seconds
setTimeout(spinner.stop, 5000)
```

MIT Licensed. Enjoy!

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