{"maintainers":[{"name":"deployment","email":"npm@mattlewis.me"}],"keywords":["scrolling","DOM"],"dist-tags":{"latest":"2.4.2"},"author":{"name":"Quentin Engles","email":"hollowdoor99@gmail.com"},"description":"Auto scroll dom elements","readme":"dom-autoscroller\n================\n\n\n\nThe syncMove option and synchronizing move\n------------------------------------------\n\n`dom-autoscroller` has a new option named syncMove.\n\n`syncMove` takes a boolean, or a function that returns a boolean, and the returned value of `syncMove` toggles the event synching of `dom-autoscroller`.\n\nWhy do that? There are some situations where `dom-autoscroller` might be doing what it does, but even though the mouse cursor moves relative to the scroll position `mousemove` events do not get fired. When you set `syncMove` to true that allows `mousemove` events with fresh coordinates to be fired for some other source that might need those events.\n\nFor now the option `syncMove` is set to false. This is for experimental purposes, and because this functionality is likely to be buggy. `touchmove` syncing is also planned, but it's best if the integration of move syncing be taken slow. Please leave plenty of issues to help integrate `syncMove`, and `mousemove` dispatch into `dom-autoscroller`.\n\nOnce movement sync is fully integrated into `dom-autoscroller` the `syncMove` option might be set to default true, or removed entirely. It depends on how things work out down the line.\n\nBig Announcement!\n-----------------\n\nVersion 2 of dom-autoscroller is out. You can upgrade to version 2.\n\nHere are the differences.\n\n-\t**pixels option removed.**\n-\tmaxSpeed option added.\n-\tSlightly different algorithm for scrolling\n-\tScrolling speed changes dynamically based on distance from element edge\n-\tCompatibility with [rollup](https://github.com/rollup/rollup).\n\nScrolling in dom-autoscroller is now much smoother. So you should upgrade to version 2.\n\nInstall\n-------\n\n**NPM**\n\n`npm install --save dom-autoscroller`\n\n**BOWER**\n\n`bower install --save dom-autoscroller`\n\nThen use browserify, webpack, or [rollup](https://github.com/rollup/rollup) to build your script.\n\nOr Download one of these files from the Github repo:\n\n-\t*dist/dom-autoscroller.js*\n-\t*dist/dom-autoscroller.min.js*\n\nIf you use one of these prepackaged files the global name is **autoScroll**.\n\nDemo\n---\n\n[jsfiddle Demo of dom-autoscroller](http://jsfiddle.net/gh/get/library/pure/hollowdoor/dom_autoscroller_demo/tree/master/Demo)\n\n\nUsage\n-----\n\nThis example uses [link-css](https://www.npmjs.com/package/link-css), and [dragula](https://www.npmjs.com/package/dragula).\n\n```javascript\nrequire('link-css')('../node_modules/dragula/dist/dragula.min.css');\nvar dragula = require('dragula'),\n autoScroll = require('dom-autoscroller');\n\n\nvar drake = dragula([document.querySelector('#list'), document.querySelector('#hlist')]);\nvar scroll = autoScroll([\n document.querySelector('#list-container'),\n document.querySelector('#container2')\n ],{\n margin: 20,\n maxSpeed: 5,\n scrollWhenOutside: true,\n autoScroll: function(){\n //Only scroll when the pointer is down, and there is a child being dragged.\n return this.down && drake.dragging;\n }\n});\n```\n\nKeep In Mind\n------------\n\n`dom-autoscroller` exploits the simplicity of the single parent, to child relationship. A scrolling element with more than one children will likely not work well with `dom-autoscroller`.\n\nFor clarity here is a more complete example:\n\n```html\n\n\n\n Drag test\n \n\n\n \n
\n - zero
\n - one
\n - two
\n - three
\n - four
\n - five
\n - six
\n - seven
\n - eight
\n - nine
\n - ten
\n - eleven
\n - twelve
\n - thirteen
\n - fourteen
\n - fifteen
\n
\n
\n
\n - zero
\n - one
\n - two
\n - three
\n - four
\n - five
\n - six
\n - seven
\n - eight
\n - nine
\n - ten
\n - 11
\n - 12
\n - 13
\n - 14
\n - 15
\n
\n