Hysen Labs
Library / SDK
callmecavs/jump.js avatar
callmecavs

jump.js

GitHub describes it as A modern smooth scrolling library.. The repository metadata lists JavaScript as its primary language. The metadata lists the MIT license. This article stays within the project description and details documented in the GitHub repository README.

3,428 stars157 forksJavaScriptMIT
01
DEEP OPEN-SOURCE ANALYSIS

callmecavs/jump.js: Usage

GitHub describes it as A modern smooth scrolling library.. The repository metadata lists JavaScript as its primary language. The metadata lists the MIT license. This article stays within the project description and details documented in the GitHub repository README.

02
DEEP OPEN-SOURCE ANALYSIS

Repository scope

GitHub describes it as A modern smooth scrolling library.. The repository metadata lists JavaScript as its primary language. The metadata lists the MIT license. The README describes the project this way: Jump was developed with a modern JavaScript workflow in mind. To use it, it's recommended you have a build system in place that can transpile ES6, and bundle modules. For a minimal boilerplate that fulfills those requirements, check out outset.

03
DEEP OPEN-SOURCE ANALYSIS

Call

The README section "Call" states: Jump exports a singleton , so there's no need to create an instance. Just call it, passing a target.

04
DEEP OPEN-SOURCE ANALYSIS

Options

The README section "Options" states: All options, except target , are optional, and have sensible defaults. The defaults are shown below:

05
DEEP OPEN-SOURCE ANALYSIS

duration

The README section "duration" states: Or, pass a function that returns the duration of the jump() in milliseconds. This function is passed the jump() distance , in px , as a parameter.

06
DEEP OPEN-SOURCE ANALYSIS

Editorial conclusion

The repository README is the source for this review. It does not replace a local installation or an independent test.

07
DEEP OPEN-SOURCE ANALYSIS

Official sources

08
Community notes

Community notes