diff options
author | Oliver Sartun <sartun@dievision.de> | 2015-12-01 22:44:12 +0100 |
---|---|---|
committer | Oliver Sartun <sartun@dievision.de> | 2015-12-01 22:44:12 +0100 |
commit | 829731e6d3bcdb5ed57d82276b6961039fe366f3 (patch) | |
tree | ef1db67e03bf51888e4ca2e93d37657d6f43863a | |
parent | 01655ae5003472ad98f276c064e8d3b78a0d84bd (diff) | |
download | jQuery.equalHeights-829731e6d3bcdb5ed57d82276b6961039fe366f3.zip jQuery.equalHeights-829731e6d3bcdb5ed57d82276b6961039fe366f3.tar.gz jQuery.equalHeights-829731e6d3bcdb5ed57d82276b6961039fe366f3.tar.bz2 |
Adding unwatch documentation + other changes
-rw-r--r-- | README.md | 12 |
1 files changed, 9 insertions, 3 deletions
@@ -21,7 +21,7 @@ Alternatively, install with [bower](https://github.com/bower/bower): ### Auto Initialize Add `data-equal="MYELEMENTS"` to the parent container, where MYELEMENTS is div, section, li, whatever you'd like. [See the example](https://github.com/mattbanks/jQuery.equalHeights/blob/master/example/example.html) for more information. -You can optioanlly specify the options by setting `data-equal-wait="true"` and `data-equal-watch="true"`. +You can specify options by setting them as a data-attribute, for example: `data-watch="true"`. ### Manually Initialize @@ -33,13 +33,19 @@ Select whatever elements need equal height. You can optionally pass in an object If you pass in `{wait: true}` your elements' height will only be equalized as soon as they have layout. - $('.yourelements').equalHeights({wait: true}) + $('.yourelements').equalHeights({wait: true}); #### Option: `watch` Pass in `{watch: true}` if you want to execute `equalHeights` on resize. This can improve the responsiveness of the elements with equalized heights. - $('.yourelements').equalHeights({watch: true}) + $('.yourelements').equalHeights({watch: true}); + +#### Option: `unwatch` + +Pass in `{unwatch: true}` to remove a set of elements that are currently watched. + + $('.yourelements').equalHeights({unwatch: true}); ### Caveats |