0.1.2 • Published 4 years ago

pixelify-img v0.1.2

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

pixelify-img

npm-badge license-badge Known Vulnerabilities Dependencies Total alerts Language grade: JavaScript

JS library for pixelating DOM images (or a portion of it).

It replaces the source of the given image with the modified version using Data URL, so any CSS applied to the original image will be keep, this method is even responsive right of the box.

TIP: Since the data is pixelated at runtime, saving the pixelated version of the image and using that instead will be a good option.

Demo

http://codepen.io/noeldelgado/pen/EGxzu/

Dependencies

None

Installation

NPM

npm intall pixelify-img --save

Usage

const image = document.querySelector('img.my_image');
const options = {
    pixel: 50,
    alpha : .5
};

new Pixelify(image, options);

API

Pixelify(image, options)

@param image

value typedefault valuedescription
HTMLImageElementundefined *requiredReference to the DOM image

@param Object:options

value namevalue typedefault valuedescription
pixelNumber10pixels size
xNumber0x-axis pixel of the image (in natural size) from which the effect will start
yNumber0y-axis pixel of the image (in natural size) from which the effect start
wNumberimage.naturalWidthwidth from x where the effect will end
hNumberimage.naturalHeightheight from y where the effect will end
alphaNumber1Opacity applied to each pixel
cleanBooleanfalseDefines if the canvas should be clear when applying alpha.

License

MIT © Noel Delgado