https://github.com/streammedev/scroll-to
Smoothly scroll somewhere
https://github.com/streammedev/scroll-to
Last synced: about 1 year ago
JSON representation
Smoothly scroll somewhere
- Host: GitHub
- URL: https://github.com/streammedev/scroll-to
- Owner: StreamMeDev
- License: isc
- Created: 2016-08-22T21:38:43.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-06T17:21:50.000Z (over 8 years ago)
- Last Synced: 2024-04-15T01:05:03.788Z (about 2 years ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scroll To
[](https://npmjs.org/package/@streammedev/scroll-to)
[](https://npmjs.org/package/@streammedev/scroll-to)
[](https://travis-ci.org/StreamMeDev/scroll-to)
[](https://github.com/JedWatson/happiness)
Smoothly transition any element's scroll position along either axis.
## Install
```
$ npm install --save @streammedev/scroll-to
```
## Usage
```javascript
var scrollTo = require('@streammedev/scroll-to');
function someEventHandler () {
scrollTo({
element: window, // The element to scroll (default is window)
y: 1000, // scroll the window to a y-coordinate of 1000px (default is 0)
x: 1000, // scroll the window to a x-coordinate of 1000px (default is 0)
duration: 500 // 500ms to complete the scrolling animation (default is 150)
});
}
// cancel an in progress animation
var stop = scrollTo();
// Will stop wherever it is in the process of the animation
stop();
```
## Development
This package follows semver, when you wish to publish a version run the proper npm command. For example, if we made a bug fix you can do this:
```
$ npm version patch
$ git push
$ npm publish
```
Here are the other types of version bumps:
- Major (`npm version major`): This is for breaking changes. Anytime a method is changed or the functionality is modified this bump should be made.
- Minor (`npm version minor`): This is for features additions. When a new method is added which doesn't affect the behavior of existing features, this bump should be made.
- Patch (`npm version patch`): This is for bug fixes. Only bump this if it is safe for production code to update wihout being QA'd. (AKA, almost never)
For each of these you can run a 'pre' version by prepending to the command, ex `npm version preminor`.
All feature development should be done on a branch off `master`. When a feature is complete and the pull request approved, publish a 'pre' version of the package for testing across environments. To install that 'pre' version of the package do the following, where the verison number contains the correct 'pre' version:
```
$ npm install --save @streammedev/scroll-to@1.0.0-0
```
Running the tests:
```
$ npm install && npm test
```