Little vanilla JS library to add interactive backgrounds to your webpages - View Demo
Installation
Install it using yarn or npm
yarn add brusher
Or you may use unpkg
http://unpkg.com/brusher/dist/brusher.min.js
Usage
For the basic usage, all you need to do is create an instance of Brusher and provide an image
import Brusher from 'brusher';
const brusher = new Brusher({
image: 'abstract.png'
});
brusher.init();
Available Options
Here is the list of options that you may use
const brusher = new Brusher({
image: 'abstract.png', // Path of the image to be used as a brush
keepCleared: true, // Put the blur back after user has cleared it
stroke: 80, // Stroke size for the brush
lineStyle: 'round', // Brush style (round, square, butt)
autoBlur: false, // Brusher will use the provided image for the blurry background
autoBlurValue: 15, // Blur strength in pixels
});
brusher.init();
A note on blurry background: although brusher is capable of generating blurry background by itself, it is recommended that you blur the image yourself and apply it to the body for improved performance. Brusher relies on CSS blur for the background. And rendering performance for the pre-provided blurred image would be of-course much better than that applied using CSS. Here is the sample CSS that you may use for the background
body {
background-size: cover;
background-position: 0 0;
background-attachment: fixed;
background-image: url(path/to/blurred/image.jpg);
}
License
MIT © Kamran Ahmed