# dom-scroller > Scroll DOM elements Latest version **1.0.2** (published 2015-12-22) · MIT license · 0 weekly downloads ## Install ```sh npm install dom-scroller pnpm add dom-scroller yarn add dom-scroller bun add dom-scroller ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.2 | | Published | 2015-12-22 | | First published | 2015-11-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Quentin Engles | | Maintainers | hollowdoor | | Keywords | scroll, scrolling, DOM | ## Links - npm: https://www.npmjs.com/package/dom-scroller - Repository: https://github.com/hollowdoor/dom_scroller - Homepage: https://github.com/hollowdoor/dom_scroller#readme - Issues: https://github.com/hollowdoor/dom_scroller/issues - npm.io page: https://npm.io/package/dom-scroller ## Dependencies (1) - [tween.js](https://npm.io/package/tween.js.md) ^16.3.1 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 1.0.2 (latest) — 2015-12-22 - 1.0.1 — 2015-11-24 - 1.0.0 — 2015-11-24 ## README dom-scroller ============ Install ------- `npm install --save dom-scroller` Usage ----- The javascript is inline, but you might be using something like browserify. If so just think of the javascript as external. ```html Dom list test
  1. zero
  2. one
  3. two
  4. three
  5. four
  6. five
  7. six
  8. seven
  9. eight
  10. nine
  11. ten
  12. eleven
  13. twelve
  14. thirteen
  15. fourteen
  16. fifteen
  1. zero
  2. one
  3. two
  4. three
  5. four
  6. five
  7. six
  8. seven
  9. eight
  10. nine
  11. ten
  12. 11
  13. 12
  14. 13
  15. 14
  16. 15
``` The Scroller API ---------------- ### createScroller(element, options) -> instance Give an element that you want to scroll to the scroller. #### options.edges = String The `edges` option gives you the ability to control where to scroll when calling the `jumpTo` method. If `edges` is set to `split` if the child is below the containing element then it will scroll to just above the bottom of the containing element. If `edges` is set to `same` then children will always scroll to the top of the container element. The default for `edges` is `split`. ### options.direction = String `direction` should be `vertical`, `horizontal`, or `both`. The default is `both`. You can constrain the scrolling direction with this option. ### options.duration The default duration for a scroll when you call any of the scrolling methods on the `scroller` instance. ### options.easing = Function Set an easing function. The default is linear. Scroller Static Methods ----------------------- ### createScroller.Easing Access to easing functions. These functions are the same as found in [tween.js](https://www.npmjs.com/package/tween.js). Look at the [documentation](https://github.com/tweenjs/tween.js/blob/master/docs/user_guide.md) for tween.js to learn more. Scroller Methods ---------------- The `duration` parameter for all methods is optional. ### tween() -> tween This creates a tween. The tween object returned is the same as a [tween.js](https://www.npmjs.com/package/tween.js) object. ### tweenScroll(side, distance, duration) -> tween Tween the scrollbar of the element. `side` should be a string equal to `Left`, or `Top`. This corresponds to `scrollTop`, and `scrollLeft`. `distance` should be a negative, or positive integer representing how many pixels you want to scroll. `duration` is the duration in milliseconds for the tween to take place. ### scrollV(distance, duration) -> tween Start a vertical scroll automatically. The same as tweenScroll, but without a side argument. ### scrollH(distance, duration) -> tween Start a horizontal scroll automatically. The same as tweenScroll, but without a side argument. ### jumpTo(element, duration) -> tween Make the container element scroll to an child element's position. `jumpTo` is dependent on the `edges` option of the constructor. Scroller Properties ------------------- ### scrollTop = Integer The same as `element.scrollTop`. ### scrollLeft = Integer The same as `element.scrollLeft`. ### scrollingV = Boolean Is the element in the act of scrolling vertically? ### scrollingH = Boolean Is the element in the act of scrolling horizontally? **There are other properties, but for the most part you should ignore those.** --- _Source: https://npm.io/package/dom-scroller · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._