Scroll

Scroll smoothly when jumping to different sections on a page.

Table of contents

• Usage
• Offset
• Callback after scroll
• Component options
• JavaScript
  • Initialization
  • Events
  • Methods

Usage

Simply add the data-z-scroll attribute to any page-internal link that contains a URL fragment to add the smooth scrolling behavior.

<a href="#my-id" data-z-scroll></a>

The height of a sticky element, for example the sticky navbar, is automatically added as offset to the scroll target so it is not covered by the sticky element.

Offset

To define a general offset when linking directly to a specific section on a page, add the offset option.

<a href="#my-id" data-z-scroll="offset: 100"></a>

If there is already an offset for a sticky element, the offset option is added up.

Callback after scroll

To receive a callback when scrolling has completed, you can listen to the scrolled event on the link element that triggered the scrolling.

<a id="js-scroll-trigger" href="#my-id" data-z-scroll></a>

zUIkit.util.on("#js-scroll-trigger", "scrolled", function () {
  alert("Done.");
});

Component options

Any of these options can be applied to the component attribute. Separate multiple options with a semicolon. Learn more

JavaScript

Learn more about JavaScript components.

Initialization

zUIkit.scroll(element, options);

Events

The following events will be triggered on elements with this component attached:

Methods

The following methods are available for the component:

ScrollTo

zUIkit.scroll(element).scrollTo(el);

Scroll to the given element.