# vicoders-preloader

> A package to show preloader

Latest version **1.0.1** (published 2017-08-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install vicoders-preloader
pnpm add vicoders-preloader
yarn add vicoders-preloader
bun add vicoders-preloader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-08-14 |
| First published | 2017-08-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vicoders |
| Maintainers | vicoders |
| Keywords | preloader |

## Links

- npm: https://www.npmjs.com/package/vicoders-preloader
- Repository: https://github.com/vicodersvn/lib-js-preloader
- Homepage: https://github.com/vicodersvn/lib-js-preloader#readme
- Issues: https://github.com/vicodersvn/lib-js-preloader/issues
- npm.io page: https://npm.io/package/vicoders-preloader

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) ^3.2.1

## Recent versions

- 1.0.1 (latest) — 2017-08-14
- 1.0.0 — 2017-08-14

## README

#Note: The plugin dependencies jquery.
## If you use webpack, please add these code to webpack.config.js
```
plugins: [
    new webpack.ProvidePlugin({
       $: "jquery",
       jQuery: "jquery"
   })
]
```

## Usage:

### Add CSS file
```
<link rel="stylesheet" type="text/css" href="./node_modules/vicoders-preloader/assets/css/preloader.min.css">
```

### To show preloader
```
import { preloader } from '../node_modules/vicoders-preloader/assets/js/preloader.js';
$(document).ready(function() {
	var obj = new preloader;
	obj.show();
});
``` 

### To hide preloader
```
import { preloader } from '../node_modules/vicoders-preloader/assets/js/preloader.js';
$(document).ready(function() {
	var obj = new preloader;
	obj.hide();
});
```

---
_Source: https://npm.io/package/vicoders-preloader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._