HowItWorks.md

⇦ Back to Table of Contents

How it works

Click the links below to understand how each imported script works:

• universalsmoothscroll-min.js (see below)
• universalsmoothscroll-ease-functions-min.js
• universalsmoothscroll-dev-helpers-min.js

API Script

The universalsmoothscroll-min.js script will declare and initialize the uss object as a public property of Window.
The uss object's properties are the API's functionalities and they can either be:

• variables (used internally)
• functions (publicly available)
  

The uss's variables are initialized after the window's load event so you should wait for it in order to use the API's functionalities.
These variables SHOULD NOT be directly manipulated: always use the provided accessors.
You will be able to recognize those internal variables because their names begin with an _ (underscore).

For instance:

//This is the name of the internal variable used by the uss object.
uss._xStepLength

//These are the accessors for the uss._xStepLength variable.
uss.getXStepLength() //Getter
uss.setXStepLength() //Setter

The main scrolling functions are:

• scrollXTo, scrollYTo and scrollTo
• scrollXBy, scrollYBy and scrollBy
• scrollIntoView and scrollIntoViewIfNeeded
  

Any scroll-animation can be stopped at any time by using:

• stopScrollingX
• stopScrollingY
• stopScrolling

There's also a handy function for anchor's smooth scrolling management:

• hrefSetup

---

The documentation about the API's functions is available in the Available Functions section.

Go to next section ⇨