npm.io
0.1.6 • Published 3 years ago

spinn

Licence
MIT
Version
0.1.6
Deps
0
Size
6 kB
Vulns
0
Weekly
0
Stars
1

Spinn

SVG spinner loader. Very cool animated spinner with settings:

  • Color
  • Background color
  • Size

Created by Eldøy Projects →

Install

npm i spinn

Usage

Server side rendered

Require lib:

const spinn = require('spinn')

Include on web page:

<script>${spinn}</spinn>

Client side rendered

Include dist/spinn-min.js:

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

Create an element where the spinner should appear:

<spinn></spinn>

Use on page, include in <script> tag:

// 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!