Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.7 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.7 KB
Raw

Image Shadow

Image Shadow is jQuery plugin for creating shadow for transparent (PNG or GIF) images. If you will try to set box-shadow CSS property to img element with transparency, you'll notice square shadow, regardless on image alpha channel. This plugin aims to add this feature.

How it works

.jquery.image-shadow.js uses canvas to create shadow with specified colors, blur radius and offset. It wrap IMG tag into wrapper, and set canvas with shadow before IMG element.

DEMO

You can find the simple demo of plugin here: http://htmlpreview.github.com/?https://raw.github.com/Kukunin/image-shadow/master/src/example.html

See example.html in src folder

How to use

Simply inject script into your page after jQuery library

<script src="jquery.image-shadow.js" type="text/javascript" charset="utf-8"></script>

and use $.imageShadow() function on your selectors. For example:

$("img").imageShadow({
    color: '#666',
    blur: 20
});

Please note, that, even if you haven't the options, pass the empty object {} as argument. If there isn't any argument, you'll receive the API object instead for initialization.

Options

Plugin has these options:

  • color: Color of shadow. Format is the same, as for CSS properties. Default: #000;
  • blur: Blur radius. Default: 0;
  • blurMethod: Can be native or manual. If native is chose, then canvas.shadowBlur will be used, if manual - blur algorithm, based on canvas pixel manipulation. Default: native;
  • offsetX: Offset by X-axis. Default: 0;
  • offsetY: Offset by Y-axis. Default: 0;
  • hidden: Whether is shadow is hidden by default. Default: false;
  • imgClass: Class of the IMG element. Default: shadowed;
  • wrapperClass: Class of the IMG wrapper. Default: shadow-wrapper;

API

Plugin support basic API calls. $.imageShadow() returns the object with API calls. For example, to remove all shadows, use:

$("img").imageShadow().destroy();

Currently, the further API calls are supported:

  • isActive: Check whether images already have the shadow or not. Returns true, if at least one image has shadow;
  • destroy: Remove shadow and revert all to the original state;
  • show: Show shadow;
  • hide: Hide shadow;
  • toggle: Toggle shadow;

Compability

Plugin is supported by any modern browser with canvas supporting. Tested in Google Chrome 17+, Firefox 12+, Opera 11.62

Internet Explorer 6-8 isn't supported, however it is real to make plugin working in future versions.

In Google Chrome 17-22 bluring works not properly (http://code.google.com/p/chromium/issues/detail?id=100703). Use blurMethod: manual for Chrome.