JSPM

translucify

0.1.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q31510F
  • License ISC

Makes uniform color image backgrounds transparent. Replaces <img> with <canvas>.

Package Exports

  • translucify

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (translucify) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Translucify

Makes an image's background pixels transparent. Replaces img with canvas.

Installation and Usage

npm install --save translucify

translucify(selectorResult, tolerance)

Use the flood-fill method for making the background transparent.

selectorResult
Type Example
jQuery object $('img:last-child')
NodeList document.querySelectorAll('img')
HTMLImageElement document.querySelector('img#product')

tolerance is a value from 0 to 1 that determines which pixels are part of same group of pixels to be flooded with transparency. Default value: 0.05

Example: drop-in usage

<html>
    <head>
        <script src="//path/to/libs/translucify.js"></script>
        ...
    </head>
    <body>
        ...
        <img src="cheese1.jpg"/>
        ...
    </body>
</html>
window.translucify($('img'));

Example: Browserify usage

var translucify = require('translucify');

...

translucify(document.querySelectorAll('img'));

Creating the reference image for testing

npm start

Running the test

npm install
grunt