Skip to content

Commit cc4a254

Browse files
committed
Document enhanced and
1 parent aa33b23 commit cc4a254

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ postpone.setThreshold( "200px" ).postpone() // Change the threshold to 200px.
6666
## API
6767

6868
### .stop()
69-
Stop watching the document for changes.
69+
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.
7070

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

7474
### .isInViewport(element, [scrollElement])
7575
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.

0 commit comments

Comments
 (0)