Table of contents
Installation
```bash
npm install --save vue-spinners
```
You could use it in the browser
```html ```Default import
Install all the components: ```javascript import Vue from 'vue' import VueSpinners from 'vue-spinners' Vue.use(VueSpinners) ``` Use specific components: ```javascript import Vue from 'vue' import { SquareSpinner } from 'vue-spinners' Vue.component('square', SquareSpinner) ``` ⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.Distribution import
Install all the components: ```javascript import 'vue-spinners/dist/vue-spinners.css' import VueSpinners from 'vue-spinners/dist/vue-spinners.common' Vue.use(VueSpinners) ``` Use specific components: ```javascript import 'vue-spinners/dist/vue-spinners.css' import { SquareSpinner } from 'vue-spinners/dist/vue-spinners.common' Vue.component('square', SquareSpinner) ``` ⚠️ You may have to setup your bundler to embed the css file in your page.Browser
```html ``` The plugin should be auto-installed. If not, you can install it manually with the instructions below. Install all the components: ```javascript Vue.use(VueSpinners) ``` Use specific components: ```javascript Vue.component('square', VueSpinners.SquareSpinner) ```Source import
Install all the components: ```javascript import Vue from 'vue' import VueSpinners from 'vue-spinners/src' Vue.use(VueSpinners) ``` Use specific components: ```javascript import Vue from 'vue' import { SquareSpinner } from 'vue-spinners/src' Vue.component('square', SquareSpinner) ``` ⚠️ You need to configure your bundler to compile.vue
files. More info in the official documentation.
Usage
This is a simple example showing the square spinner
```javascriptmain.js
import Vue from 'vue'
import VueSpinners from 'vue-spinners'
Vue.use(VueSpinners)
```
Then use it inside your vue component (.vue) file
```jsx<square></square>
You can also pass down loading prop in order to dynamically show this spinner
```jsx<square v-bind:loading="isLoading"></square>
Example
All the live examples live in here
---Plugin Development
Installation
The first time you create or clone your plugin, you need to install the default dependencies: ``` npm install ```Watch and compile
This will run webpack in watching mode and output the compiled files in thedist
folder.
```
npm run dev
```
Use it in another project
While developping, you can follow the install instructions of your plugin and link it into the project that uses it. In the plugin folder: ``` npm link ``` In the other project folder: ``` npm link vue-spinners ``` This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.Publish to npm
You may have to login to npm before, withnpm adduser
. The plugin will be built in production mode before getting published on npm.
```
npm publish
```
Manual build
This will build the plugin into thedist
folder in production mode.
```
npm run build
```
---