vue-fun-loading/README.md

# vue-fun-loading

[![NPM version](https://img.shields.io/npm/v/vue-fun-loading.svg?style=flat)](https://npmjs.com/package/vue-fun-loading)

A fun vue loading components.

CDN: [UNPKG](https://unpkg.com/vue-fun-loading/) | [jsDelivr](https://cdn.jsdelivr.net/npm/vue-fun-loading/)

[DEMO](https://vue-fun-loading.netlify.com/)

## Install

```bash
npm install vue-fun-loading --save-dev
```

## Usage

In main.js, import and use vue-fun-loading:
```
import Vue from 'vue';
import App from './App.vue';
import VueFunLoading From 'vue-fun-loading';

Vue.use(VueFunLoading);

new Vue({
  el: '#app',
  render: h => h(App)
})
```

Then you can use vue-fun-loading anywhere.
```
<template>
  <div id="app">
      <vue-fun-loading size="small" color="#5872bc" type="circle-dot" />
  </div>
</template>
```

## API
| Property | Description | type | Default | Enum |
| -------- | ----------- | ---- | ------- | ---- |
| size | this property defines loading component's size | string | 'middle' | 'small', 'middle', 'large' |
| color | loading component's color | string | '#ff69b4' | any color in 16 bit rgb format |
| type | loading type of different style | string | 'circle-dot' | explain in demo |

## Notification
This tool is aim for summarizing loading and learning how to build a vue components.
It's not perfect but will update later, welcome any suggestion.

## License

MIT &copy; [ownghy](https://github.com/OwnGhy)