Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

A simple, flexible spinner for Vue.js
https://github.com/dzwillia/vue-simple-spinner

component progress spinner ui vue vuejs

Last synced: 19 days ago
JSON representation

A simple, flexible spinner for Vue.js

Awesome Lists containing this project

README

        

# vue-simple-spinner
> A simple, flexible spinner for Vue.js

vue-simple-spinner is designed to be a lightweight [Vue.js](http://vuejs.org) spinner requiring minimal configuration.

## Documentation
[https://github.com/dzwillia/vue-simple-spinner/](https://github.com/dzwillia/vue-simple-spinner/)

## Demo

[https://dzwillia.github.io/vue-simple-spinner/examples](https://dzwillia.github.io/vue-simple-spinner/examples)

## Requirements
* [Vue.js](http://vuejs.org/) (^v2.1.4)

## Browser support
IE 10+ (due to [CSS animation support](https://caniuse.com/#feat=css-animation)).

## Installation

### NPM

```bash
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.*

```js
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

...






new Vue({
el: '#app'
})

```

## Examples

### Medium size
```

```

### Custom line color
```

```

### Custom font size and message
```

```

[More live code examples on JSFiddle](http://jsfiddle.net/dzwillia/kc5ka8zu)

## 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](LICENSE).

Copyright (c) 2017 [David Z Williams](https://twitter.com/padredaveo).

> *PS: I would love to know if you're using vue-simple-spinner. Tweet to me at [@padredaveo](https://twitter.com/padredaveo)*.