diff options
author | Ryan Van Etten <ryanve@gmail.com> | 2012-05-30 19:06:37 -0400 |
---|---|---|
committer | Ryan Van Etten <ryanve@gmail.com> | 2012-05-30 19:06:37 -0400 |
commit | b9009221a8b92d9acb1041503f024fc3e7f23a7d (patch) | |
tree | 3eb84cc6c23d528a1e9d17eec8aaf4cc7bd1ecea | |
parent | 00ab0767bcd31cdc3d5b12e018eea1a2f37f9409 (diff) | |
download | verge-b9009221a8b92d9acb1041503f024fc3e7f23a7d.zip verge-b9009221a8b92d9acb1041503f024fc3e7f23a7d.tar.gz verge-b9009221a8b92d9acb1041503f024fc3e7f23a7d.tar.bz2 |
update docs
-rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -57,6 +57,17 @@ $('div').inY(0, true) // contains div's outside the y-axis section that the view verge.inY.call($('div')) // get *array* that contains div's in the same y-axis section as the viewport ``` +### $.fn.rectangle() + +Get an element's (or the first element in a set's) rectangle **object** containing the properties `top`, `bottom`, `left`, `right`, `width`, and `height` with respect to the top-left corner of the current viewport, and with an optional verge amount. + +```js +$(elem).rectangle() // returns object +$(elem, verge).rectangle() // returns object adjusted by verge +``` + +See full details in the docs for the top-level `$.rectangle()` method. (This is the chainable form of that.) + ## top-level ### $.viewportW() |