npmpackage.info

Gathering detailed insights and metrics for smooth-scroll-operator

smooth-scroll-operator - 5.0.7 | npmpackage.info

smooth-scroll-operator

A dead simple and lightweight smooth scroll animation utility. Scroll any element. Comes with bezier curve support and a small library of pre-defined easing functions. Animations respect clock.

5.0.7

MIT

JavaScript

17.08 kB

1.5

Installations

npm install smooth-scroll-operator

Developer Guide

BETA

Typescript

No

Module System

CommonJS, UMD

Pull Requests

Open

6

Total

9

Closed

3

Issues

Open

0

Total

0

Closed

0

Releases

v5.0.7

Updated on Jun 07, 2019

v5.0.6

Updated on Jun 07, 2019

v5.0.5

Updated on Jun 07, 2019

Update dependency

v5.0.4

Updated on Jun 06, 2019

v5.0.3

Updated on Jun 06, 2019

v5.0.2

Updated on Jun 06, 2019

View All 8 releases

Languages

JavaScript

JavaScript (100%)

Developer

mhweiner

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

62 Commits

2 Watchers

7 Branches

1 Contributors

Updated on Jun 07, 2019

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

5.0.7

Package Id

smooth-scroll-operator@5.0.7

Unpacked Size

17.08 kB

Size

6.12 kB

File Count

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

dom-animate

Dev Dependencies

np rollup rollup-plugin-commonjs rollup-plugin-node-resolve rollup-plugin-uglify

smooth-scroll-operator

A dead simple and lightweight library to animate the scroll of the window or any HTMLElement.

No need to ask, he's a smooth operator...

Really small filesize, only 1 dependency (~3KB uncompressed, including dependencies).
Supports Beizer Curves and custom easing functions, with predefined values.
Custom timing function (uses RAF by default if available)
Pause/resume/stop/restart
Animations respect the actual clock, so no matter the frame rate, the animation will still properly last the appropriate amount of time.

Installation

NPM:

1npm i smooth-scroll-operator

browser:

You can use either smooth-scroll-operator.umd.js or smooth-scroll-operator.min.umd.js from the latest release in a script tag. This includes all dependencies.

1<script src="smooth-scroll-operator.min.umd.js"></script>
2<script>
3    SmoothScrollOperator.scrollY(window, 500);
4</script>

Example Usage

1import sso from 'smooth-scroll-operator';
2
3let el = document.querySelector('.myElement');
4
5//scroll el to 500
6sso.scrollY(el, 500);
7
8// Scroll to y = 500, with a duration of 200ms, and a custom cubic-bezier easing function:
9sso.scrollY(el, 500, {
10  duration: 200,
11  easing: [0.42, 0.0, 0.58, 1.0]
12});
13
14// Scroll to y = 500, with a duration of 200ms, and a pre-defined easing function.
15sso.scrollY(el, 500, {
16  duration: 200,
17  easing: sso.EASING.EASE_IN
18});
19
20//scroll window
21sso.scrollY(window, 500);
22
23//Scroll and then pause animation 300ms later.
24let animation = sso.scrollY(el, 500);
25
26setTimeout(() => {
27  
28  animation.pause();
29  
30}, 300);
31
32//resume 400ms later.
33setTimeout(() => {
34  
35  animation.resume();
36  
37}, 400);
38
39//Scroll and then immediately stop animation
40let animation = sso.scrollY(window, 500);
41
42animation.stop();

API

`scrollY({HTMLElement|window} el, {number} targetY, {object=} options)`

Animates the scrolling of a given element (scrolls to target position). Returns an instance of DOMAnimate. You can stop, pause, or resume the animation by calling .stop(), .pause(), or .resume(), respectively, on the returned instance.

`{HTMLElement} el`

The element to scroll. Can be window.

`{number} targetY`

The y position to animate/scroll to in pixels.

`{object=} options`

An optional map of parameters:

`{integer} duration`

Animation duration in milliseconds. (Default: 400)

`{array} easing`

An array to pass to the cubic-bezier easing function. (Default: SmoothScrollOperator.EASE_IN_OUT)

`{function} onComplete`

A callback function that is called when the animation is finished.

Constants

`EASING`

smooth-scroll-operator ships with a small Bezier Curve library:

EASING.EASE
EASING.EASE_IN
EASING.EASE_OUT
EASING.EASE_IN_OUT
EASING.LINEAR

License

MIT. Free to use in all your things!

Contribution

DO IT! PR's welcome. Need to add testing, linting, and support for scrollX, or both x/y at the same time.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More