vue-csspin
Version:
vue spinner component for vue.js 3.x(css-pin wrapper)
197 lines (186 loc) • 6.02 kB
Markdown
# vue-csspin
Spinner Component for Vue.js 3.x.
This project is an wrapper of [CSSPIN](https://www.npmjs.com/package/csspin)
csspin for vue 2.x is [here](https://github.com/stepanowon/vue2-csspin)
[](https://www.npmjs.com/package/vue-csspin)
[](https://www.npmjs.com/package/vue-csspin)
[](https://github.com/stepanowon/vue-csspin/stargazers)
[](https://github.com/stepanowon/vue-csspin/network)
[](https://travis-ci.org/stepanowon/vue-csspin)
[]()
------------
> Author : Stephen Won(원형섭), OpenSG Inc.
> Online Demo : https://vue-csspin.vercel.app/
## License
MIT
## Usage
#### CDN - usage
~~~
<html>
<head>
<meta charset="utf-8">
<title>vue-csspin 테스트</title>
<link rel="stylesheet" href="https://unpkg.com/vue-csspin/dist/vue-csspin.css" />
</head>
<body>
<div id="app">
<h2>VueCsspin Test</h2><hr />
Loading Message : <input type="text" v-model="message" /><br />
Spinner Style :
<select v-model="spinStyle">
<option>cp-round</option>
<option>cp-pinwheel</option>
<option>cp-balls</option>
<option>cp-bubble</option>
<option>cp-flip</option>
<option>cp-hue</option>
<option>cp-skeleton</option>
<option>cp-eclipse</option>
<option>cp-boxes</option>
<option>cp-morph</option>
<option>cp-heart</option>
<option>cp-meter</option>
</select><br />
opacity(0 < x < 1) : <input type="text" v-model.number="opacity" /><br />
background-color :
<select v-model="color">
<option>black</option>
<option>white</option>
<option>red</option>
<option>yellow</option>
<option>blue</option>
<option>aqua</option>
<option>green</option>
<option>orange</option>
<option>brown</option>
<option>salmon</option>
<option>chocolate</option>
<option>bisque</option>
</select><br />
<button @click="viewVueCsspin">Test Spinner</button>
<vue-csspin v-if="visible" :message="message" :spin-style="spinStyle" :color="color" :opacity="opacity" />
</div>
<script src="https://unpkg.com/vue@next"></script>
<script type="text/javascript" src="https://unpkg.com/vue-csspin"></script>
<script type="text/javascript">
var app = Vue.createApp({
name: 'App',
data() {
return {
visible: false,
message: "Loading",
spinStyle : "cp-round",
opacity : 0.7,
color : "white",
};
},
methods : {
viewVueCsspin() {
this.visible = true;
setTimeout(()=>{
this.visible = false;
}, 5000)
}
}
})
VueCsspin.default(app)
app.mount("#app")
</script>
</body>
</html>
~~~
##
#### NPM - install
~~~
npm install --save vue-csspin
- or -
yarn add vue-csspin
~~~
#### NPM - usage
~~~
<template>
<div>
<h2>VueCsspin Test</h2><hr />
Loading Message : <input type="text" v-model="message" /><br />
Spinner Style :
<select v-model="spinStyle">
<option>cp-round</option>
<option>cp-pinwheel</option>
<option>cp-balls</option>
<option>cp-bubble</option>
<option>cp-flip</option>
<option>cp-hue</option>
<option>cp-skeleton</option>
<option>cp-eclipse</option>
<option>cp-boxes</option>
<option>cp-morph</option>
<option>cp-heart</option>
<option>cp-meter</option>
</select><br />
opacity(0 < x < 1) : <input type="text" v-model.number="opacity" /><br />
background-color :
<select v-model="color">
<option>black</option>
<option>white</option>
<option>red</option>
<option>yellow</option>
<option>blue</option>
<option>aqua</option>
<option>green</option>
<option>orange</option>
<option>brown</option>
<option>salmon</option>
<option>chocolate</option>
<option>bisque</option>
</select><br />
<button @click="viewVueCsspin">Test Spinner</button>
<vue-csspin v-if="visible" :message="message" :spin-style="spinStyle" :color="color" :opacity="opacity" />
</div>
</template>
<script>
import { VueCsspin } from 'vue-csspin'
import 'vue-csspin/dist/vue-csspin.css';
export default {
name: 'App',
components: {
VueCsspin
},
data() {
return {
visible: false,
message: "Loading",
spinStyle : "cp-round",
opacity : 0.7,
color : "white",
};
},
methods : {
viewVueCsspin() {
this.visible = true;
setTimeout(()=>{
this.visible = false;
}, 5000)
}
}
}
</script>
~~~
##
#### Props
* message
- type : String
- Loading Message
- Default : "Loading"
* spinStyle
- type : String
- Spinner Style
- default : "cp-round"
- available value : "cp-round", "cp-pinwheel", "cp-bubble", "cp-flip", "cp-hue", "cp-skeleton", "cp-eclipse", "cp-boxes", "cp-morph", "cp-heart", "cp-meter"
- about more detail style ---> https://webkul.github.io/csspin/
* color
- type : String
- default : "white"
* opacity
- type : number(0 < x < 1)
- default : 0.7