diff options
| author | Ryan Van Etten <ryanve@gmail.com> | 2012-05-30 18:47:21 -0400 |
|---|---|---|
| committer | Ryan Van Etten <ryanve@gmail.com> | 2012-05-30 18:47:21 -0400 |
| commit | ffcfc3aea55a3d35664c89cc7472331b12c08dd9 (patch) | |
| tree | c6ca741d1f97a9b92a44660cc55cfe45f5a48c55 | |
| parent | 8f91329b46a9776842e46ec87a12f1ef803e32e5 (diff) | |
| download | verge-ffcfc3aea55a3d35664c89cc7472331b12c08dd9.zip verge-ffcfc3aea55a3d35664c89cc7472331b12c08dd9.tar.gz verge-ffcfc3aea55a3d35664c89cc7472331b12c08dd9.tar.bz2 | |
update docs
| -rw-r--r-- | README.md | 8 |
1 files changed, 1 insertions, 7 deletions
@@ -9,7 +9,7 @@ To simplify the docs below, let `$` represent `verge` or the host lib. ## chainable -The chainable versions of `inX`/`inY`/`inViewport` are **filters** designed for use with jQuery (or jQuery-compatible hosts). All three use the same signature: +The chainable versions of `inX`/`inY`/`inViewport` are **filters** designed for use with jQuery (or jQuery-compatible hosts). All three use the same signature: `$(elems).inY(verge, invert)` where both parameters are optional: ```js @param {number=} verge is an optional cushion amount in pixels to surround the @@ -17,12 +17,6 @@ The chainable versions of `inX`/`inY`/`inViewport` are **filters** designed for @param {boolean=} invert when set to true, will invert the filter. (default: false) ``` -```js -$(elems).inViewport() -$(elems).inViewport(verge) -$(elems).inViewport(verge, invert) -``` - ### $.fn.inViewport() Filter a matched set so that it contains only elements that are in the current viewport. An element is considered in the viewport if at least one pixel of it is in the viewport. Returns the filtered set (e.g. jQuery object). |