blur-overlay
jQuery plugin for creating blurry overlays. Can customize the content, blur amount, and transition types.
Requires jQuery (>=2.2.4
) and jQuery UI (>=1.12.0
).
Installation
You can install blur-overlay from a package manager:
- npm:
npm install --save blur-overlay
- bower:
bower install --save blur-overlay
Or you can grab the latest .js
file:
- Development (unminified, ~8kb)
- Production (minified, ~4kb)
Usage
;
Developing
First and foremost, fork/clone the repo and run:
cd blur-overlay# Use the recommended node version (6.x) nvm use# Install dependencies npm install
If you don't have nvm
, get it here: https://github.com/creationix/nvm
npm scripts
Use the npm scripts defined in package.json
to perform common build tasks:
Command | Description |
---|---|
npm start |
Run lint, tests, and build upon changes to src/ and spec/ |
npm test |
Run unit tests using Karma and PhantomJS (single-run only) |
npm run test:serve |
Start the Karma server (can debug at http://localhost:9876) |
npm run lint |
Lint src/ and spec/ with ESLint (with --fix flag) |
npm run build |
Transpile src/ using Babel and minify using UglifyJS2, sending output to dist/ |
npm run demo |
Launch the demo page (index.html ) |
Make sure to run npm run build
in between code changes to keep the demo page up-to-date!
License
MIT. See LICENSE.