A simple, flexible spinner for Vue.js
Clone or download
Latest commit fc55bc7 Sep 2, 2018

README.md

vue-simple-spinner

A simple, flexible spinner for Vue.js

vue-simple-spinner is designed to be a lightweight Vue.js spinner requiring minimal configuration.

Documentation

https://github.com/dzwillia/vue-simple-spinner/

Demo

https://dzwillia.github.io/vue-simple-spinner/examples

Requirements

Browser support

IE 10+ (due to CSS animation support).

Installation

NPM

npm install vue-simple-spinner --save

Usage

All styling for this component is done via computed styles in the Spinner.vue component and requires no external CSS files.

ES6

The following examples can also be used with CommonJS by replacing ES6-specific syntax with CommonJS equivalents.

import Vue from 'vue'
import Spinner from 'vue-simple-spinner'

new Vue({
  components: {
    Spinner
  }
})

Globals (script tag)

Add a script tag pointing to dist/vue-simple-spinner.min.js after adding Vue.

Example:

<html>
<head>
  ...
</head>
<body>
  <div id="app">
    <vue-simple-spinner></vue-simple-spinner>
  </div>

  <script src="path/to/vue.js"></script>
  <script src="path/to/vue-simple-spinner.js"></script>
  <script>
    new Vue({
      el: '#app'
    })
  </script>
</body>
</html>

Examples

Medium size

<vue-simple-spinner size="medium" />

Custom line color

<vue-simple-spinner line-fg-color="#009900" />

Custom font size and message

<vue-simple-spinner spacing="55" message="I'm 55px below the vue-simple-spinner" />

More live code examples on JSFiddle

Options

Props Type Values Default
size Number | String tiny, small, medium, large, huge, massive, {n} 32
line-size Number Any Number 3
line-bg-color String Color #eee
line-fg-color String Color #2196f3
speed Number Number (in seconds) 0.8
spacing Number Number (in pixels) 4
message String Text to display (empty string)
font-size Number Number (in pixels) 13
text-fg-color String Color #555

License

vue-simple-spinner is open source and released under the MIT License.

Copyright (c) 2017 David Z Williams.

PS: I would love to know if you're using vue-simple-spinner. Tweet to me at @padredaveo.