summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOliver Sartun <sartun@dievision.de>2015-11-11 20:51:51 +0100
committerOliver Sartun <sartun@dievision.de>2015-11-11 20:51:51 +0100
commit464a68a41945dc6514b28a0d2d620fad3f6fffb5 (patch)
treeab0782ee31205bec696c8d3d331efd254acf2304
parentbf409366fe03b983188676d973fef900057af35e (diff)
downloadjQuery.equalHeights-464a68a41945dc6514b28a0d2d620fad3f6fffb5.zip
jQuery.equalHeights-464a68a41945dc6514b28a0d2d620fad3f6fffb5.tar.gz
jQuery.equalHeights-464a68a41945dc6514b28a0d2d620fad3f6fffb5.tar.bz2
Add section about options to Readme
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9fa7b06..9db8419 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,21 @@ Add `data-equal="MYELEMENTS"` to the parent container, where MYELEMENTS is div,
### Manually Initialize
- $('.yourelements').equalHeights();
+ $('.yourelements').equalHeights([options]);
-Select whatever elements need equal height.
+Select whatever elements need equal height. You can optionally pass in an object with one or more options
+
+#### `wait`
+
+If you pass in `{wait: true}` `equalHeights` is executed with a delay of 100ms. This adds additional time in which the content can change – for example when fonts are loaded and applied or when the content is changed dynamically.
+
+ $('.yourelements').equalHeights({wait: true})
+
+#### `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})
### Caveats