Skip to content

Commit

Permalink
Document enhanced and
Browse files Browse the repository at this point in the history
  • Loading branch information
squat committed Nov 11, 2013
1 parent aa33b23 commit cc4a254
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ postpone.setThreshold( "200px" ).postpone() // Change the threshold to 200px.
## API

### .stop()
Stop watching the document for changes.
Stop all of postpone's functionality. This means postpone will stop watching the document for changes and will unbind any scroll events associated with postponed elements.

### .start()
If you have paused postpone's watcher, you can start it back up with `.start()`.
If you have paused postpone's watcher and unbound its scroll evnts using `.stop()`, you can start it all back up with `.start()`.

### .isInViewport(element, [scrollElement])
Check if your `element` is somewhere in the browser's viewport, where `element` and `scrollElement` are DOM nodes. If `scrollElement` is not specified, postpone assumed `element` scrolls with respect to the document.
Expand Down

0 comments on commit cc4a254

Please sign in to comment.