https://github.com/bot-academia/vue-ui-preloader
Pre Loader components for vue.js
https://github.com/bot-academia/vue-ui-preloader
loader preloader vue vuejs
Last synced: 11 months ago
JSON representation
Pre Loader components for vue.js
- Host: GitHub
- URL: https://github.com/bot-academia/vue-ui-preloader
- Owner: Bot-Academia
- License: mit
- Created: 2020-07-04T16:23:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-24T10:02:53.000Z (over 2 years ago)
- Last Synced: 2024-04-12T17:17:40.116Z (about 2 years ago)
- Topics: loader, preloader, vue, vuejs
- Language: Vue
- Homepage: https://vue-preloader.netlify.app/
- Size: 3.5 MB
- Stars: 22
- Watchers: 2
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.codacy.com/gh/Bot-Academia/Vue-ui-preloader?utm_source=github.com&utm_medium=referral&utm_content=Bot-Academia/Vue-ui-preloader&utm_campaign=Badge_Grade_Dashboard)
[](https://app.netlify.com/sites/vue-preloader/deploys)
[](https://img.shields.io/badge/language-vue-green.svg)
[](https://img.shields.io/badge/license-MIT-000000.svg)
[](https://www.npmjs.com/package/vue-ui-preloader)
[](https://www.npmjs.com/package/vue-ui-preloader)
[](https://nodei.co/npm/vue-ui-preloader/)
## Demo and playground
Live demo - https://vue-preloader.netlify.app/
[Playground Website](https://vue-preloader.netlify.app/).
Adjust the settings using the playground options. On the bottom of the page you will find the source code that you can directly use in your project or you can manually change the props.
npm link - https://www.npmjs.com/package/vue-ui-preloader
## Installation
```bash
# use yarn
yarn add vue-ui-preloader
# use npm
npm install --save vue-ui-preloader
```
## Usage
Vue 2 Sandbox link - https://codesandbox.io/s/hungry-grass-7fx4z?file=/src/App.vue
In your main.js
```js
import loader from "vue-ui-preloader";
Vue.use(loader);
```
In your template
```vue
```
>note(you can either use the [playground](https://vue-preloader.netlify.app/) website to automatically get all the props set or you can set them manaully using the below prop list. You can also resort to not passing any prop, in this case the preloader will use default settings.)
## Via CDN
CDN demo link - http://jsfiddle.net/8961cm0s/1/
In your index.html
```html
```
In your template
```html
```
In your main.js
```js
Vue.use(loader)
new Vue({
el: '#app',
components:{
loader:loader
}
});
```
## Props
| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| name | string | 'spinning' | decides the type of loader |
| object | string | '#ff9633' | set the color of the loaders. hex or color |
| color1 | string | only for circular | set the color of the circular loader disk1. hex or color |
| color2 | string | only for circular | set the color of the circular loader disk2. hex or color |
| size | number | 5 | set the size of loader |
| bg | string | '#343a40' | set the color of the loader background. hex or color |
| objectbg | string | '#999793' | set the color of the loader object background. hex or color |
| opacity | number | 80 | set the opacity of background |
| speed | number | 2 | animation speed in seconds |
| disableScrolling | boolean | false | disable page scrolling when preloader is open |
## Author
© [Vinayak sharma](https://github.com/vinayaksh42)
[Hrishikesh Agarwal](https://github.com/codetheorem)