Skip to content

Commit

Permalink
updated readme with known limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
liabru committed Sep 21, 2014
1 parent b52448a commit 57ee64a
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ See the [jquery.matchHeight.js demo](http://brm.io/jquery-match-height-demo).

### Features

- match the heights of elements anywhere on the page
- row aware, handles floating elements
- responsive, automatically updates on window resize (can be throttled for performance)
- handles mixed `padding`, `margin`, `border` values (even if every element has them different)
- handles images and other media (updates automatically after loading)
- handles hidden or none-visible elements (e.g. those inside tab controls)
- accounts for `box-sizing`
- data attributes API
- tested in IE8+, Chrome, Firefox, Chrome Android
- can be removed when needed
- maintain scroll position correctly
- tested in IE8+, Chrome, Firefox, Chrome Android

### Status

Expand Down Expand Up @@ -119,6 +120,18 @@ If you are observing this behaviour, use the above line to automatically attempt

The array that contains all element groups that have had `matchHeight` applied. Used for automatically updating on resize events. Search and modify this array if you need to remove any groups or elements, for example if you're deleting elements.

### Known limitations

#### CSS transitions and animations are not supported

You should ensure that there are no transitions or other animations that will delay the height changes of the elements you are matching, including any `transition: all` rules. Otherwise the plugin will produce unexpected results, as animations can't be accounted for.

#### Delayed webfonts may cause incorrect height

Some browsers [do not wait](http://www.stevesouders.com/blog/2009/10/13/font-face-and-performance/) for webfonts to load before firing the window load event, so if the font loads too slowly the plugin may produce unexpected results.

If this is a problem, you should call `_update` once your font has loaded by using something like the [webfontloader](https://github.com/typekit/webfontloader) script.

### Changelog

To see what's new or changed in the latest version, see the [changelog](https://github.com/liabru/jquery-match-height/blob/master/CHANGELOG.md)
Expand Down

0 comments on commit 57ee64a

Please sign in to comment.