Jonas Hübotter

Apps Open Source Contact

Blurry.js

Blurry image loading with StackBlur

Blurry.js - Blurred image loading with StackBlur

NPM Version

Blurry.js makes blurred image loading a breathe. With very little markup, Blurry.js allows you to level up the game of your image loading functionality, by making it look & perform great.


Table of Contents


Information

Size: Blurry.js takes < 1kb gzipped.

Dependencies: StackBlur


Usage

Blurry.js is simple to use:

import * as blurry from 'blurry';
window.onload = () => blurry.init({ blur: 120, delay: 1250 });
@import "blurry/src/blurry"
<div class="blurry-media">
    <div class="aspect-ratio-fill"></div>
    <div class="blurry-media--wrapper">
        <img class="blurry-media--thumbnail" src="image.jpeg?quality=20">
        <canvas class="blurry-media--canvas"></canvas>
        <img class="blurry-media--image" src="image.jpeg">
    </div>
</div>

Options

You have some configuration options:

  • blur: Blur radius as defined by StackBlur. Accepts a float value. Defaults to 100. To find a value you like check out the StackBlur demo.
  • delay: Milliseconds to wait before removing the blur effect. Accepts an integer. Defaults to 1000.

To Do

Here is the full list of current projects.

To propose your ideas, initiate the discussion by adding a new issue.


Contributing

We hope that you will consider contributing to Blurry.js. Please read this short overview for some information about how to get started:

Learn more about contributing to this repository, Code of Conduct

Contributors

Give the people some ❤️ who are working on this project. See them all at:

https://github.com/jonhue/blurry.js/graphs/contributors

Semantic Versioning

Blurry.js follows Semantic Versioning 2.0 as defined at http://semver.org.

License

MIT License

Copyright (c) 2017 Jonas Hübotter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

JavaScript

Updated 16 days ago