css-js-filter

css-js-filter

Set of predefined CSS filters realised via JS along with utils to create your own.

Installation

yarn add css-js-filter

or

npm i css-js-filter

Usage

Basic

Each filter class contains realisation for both JS and CSS parts. So, if it is required to modify image directly (means modify its pixels), then JS part of filter should be used. In case when the only 1 required thing from filter is to display what will happen, when we apply it via JS,we could use filter's CSS part.

JavaScript / TypeScript

import {BrightnessFilter} from 'css-js-filter';

// Lets imagine, we have some canvas with image inside.
const canvas = document.getElementById('canvas');

// Get canvas context.
const context = canvas.getContext('2d');

// Get canvas image data which should be modified.
const imageData = context.getImageData(0, 0, canvas.width, canvas.height);

// Decrease image brightness by 70%
const modifiedImageData = BrightnessFilter.applyTo(imageData, 30);

// Put modified image data on canvas.
context.putImageData(modifiedImageData, 0, 0);

// Now we have new image with decreased brightness on canvas!

CSS

In case when there is no real need to modify image directly, it is strongly recommended to use CSS part of filters. Remember, that use of CSS works much faster than JS does.

You could use CSS filters when the only 1 thing is required from filters - to display what happens, when you apply them.

Then, when you should really apply filters to image and download it, you have to switch to JS way.

Let's look how it works.

import {BrightnessFilter, SaturationFilter} from 'css-js-filter';

const canvas = document.getElementById('canvas');

// Get filter CSS representation.
const brightnessFilter = BrightnessFilter.getCSSFilter(30);
const saturationFilter = SaturationFilter.getCSSFilter(23);

// As a result, we are getting here value "brightness(30%) saturate(23%)".
const cssFilter = [brightnessFilter, saturationFilter].join(' ');

// Then, we should use created filter in canvas style (or any other 
// element).
canvas.style.filter = cssFilter;

// ...and, thats all!

Moreover, created CSS filter is compatible with canvas context's filter property. Nevertheless, context's filter is not supported by some browsers.

import {BrightnessFilter, SaturationFilter} from 'css-js-filter';

const canvas = document.getElementById('canvas');
const context = canvas.getContext('2d');

// Get filter CSS representation.
const brightnessFilter = BrightnessFilter.getCSSFilter(30);
const saturationFilter = SaturationFilter.getCSSFilter(23);

// As a result, we are getting here value "brightness(30%) saturate(23%)".
const cssFilter = [brightnessFilter, saturationFilter].join(' ');
context.filter = cssFilter;

// Then, we should draw image or some another primitive. Pay attention to the 
// moment, that we are not using putImageData due to this method avoids all
// modifications and replaces pixels directly.
const image = new Image();
image.src = '...';
image.onload = () => context.drawImage(image, 0, 0);

Of course, you could use those filters not only for canvas but the other html elements. It only generates a string, compatible with CSS's filter property.

Advanced

Creating Instagram filter

As an example, we take Instagram's filter "1977". According to this link, we can find out which CSS filters are applied when this filter is used. So, lets try to create JS filter for "1977".

import {
  createCSSFilter,
  SepiaFilter,
  HueRotationBrowserFilter,
  SaturationFilter, forEachPixel, assignPixel, ICSSFilter,
} from 'css-js-filter';

// Remember instagram filter definition. Its order is important:
// sepia(.5) hue-rotate(-30deg) saturate(1.4)
const filters: [ICSSFilter, number][] = [
  [SepiaFilter, 50],
  [HueRotationBrowserFilter, -30],
  [SaturationFilter, 140],
];

const Inst1977CSSFilter = createCSSFilter({
  name: 'Inst1977CSSFilter',
  // Define custom getCSSFilter function. We are assuming, that value
  // should be in limits like [0, 100]. Lets call it filter's "intensity".
  getCSSFilter(intensity: number): string {
    // When we are changing from 0 to 100, we should see difference
    // between images. Filter becomes much more noticeable when value comes
    // really close to 100.
    intensity = Math.min(Math.max(intensity, 0), 100) / 100;

    // Loop through each filter and use its settings.
    return filters
      .map(([Filter, value]) => Filter.getCSSFilter(value * intensity))
      .join(' ');
  },
  defaultValue: 0,
  // Custom filter's JS part.
  processImage: (image, intensity, type) => {
    intensity = Math.min(Math.max(intensity, 0), 100) / 100;

    // Loop through each pixel.
    forEachPixel(image, type, ((i, r, g, b) => {
      // Apply all of the filters to pixel.
      filters.forEach(([Filter, value]) => {
        // NOTE: To be replaced in near future. 
        assignPixel(image, i, Filter.applyTo([r, g, b], value * intensity));
      });
    }));

    return image;
  },
});