smooth-scroller

WebJar for smooth-scroller

License	MIT
GroupId	org.webjars.npm
ArtifactId	smooth-scroller
Last Version	2.2.1
Release Date	Apr 18, 2021
Type	jar
Description	smooth-scroller WebJar for smooth-scroller
Project URL	https://www.webjars.org
Source Code Management	https://github.com/firstandthird/smooth-scroller

Download smooth-scroller

Filename	Size
smooth-scroller-2.2.1.pom
smooth-scroller-2.2.1.jar	8 KB
smooth-scroller-2.2.1-sources.jar	22 bytes
smooth-scroller-2.2.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/smooth-scroller/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>smooth-scroller</artifactId>
    <version>2.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/smooth-scroller/
implementation 'org.webjars.npm:smooth-scroller:2.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/smooth-scroller/
implementation ("org.webjars.npm:smooth-scroller:2.2.1")

Apache Buildr

'org.webjars.npm:smooth-scroller:jar:2.2.1'

Apache Ivy

<dependency org="org.webjars.npm" name="smooth-scroller" rev="2.2.1">
  <artifact name="smooth-scroller" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='smooth-scroller', version='2.2.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "smooth-scroller" % "2.2.1"

Leiningen

[org.webjars.npm/smooth-scroller "2.2.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : domassist	jar	[2.2.0,3)

Project Modules

There are no modules declared in this project.

Smooth-scroller

A tiny, ES6 JavaScript lib to handle smooth scrolling.

Installation

npm install smooth-scroller

Usage

See the full example.

Javascript

import 'smooth-scroller';

HTML

<a href="#foo" data-smooth>Scroll Smoothly</a>
...some content...
<div id="foo"></div>

Events

Custom events are fired on the element:

Event	Description
smoothscroll:start	Smooth scroll starts
smoothscroll:end	Smooth scroll ends

Methods

Smooth-scroller exposes two methods:

init([selector='[data-smooth]'], [offset=0])

Enables smooth-scroller on the elements matched by selector.

Parameters

selector='[data-smooth]' - {String} - Elements that will trigger smooth-scroll call once they're clicked

offset=0 - {Number} - Controls the distance (negative or positive) between the top border of the element and the top border of the window.

scroll(target, hash, [offset=0], [silent=false])

target - {string|Element|NodeList} - Target element to scroll

hash - {string|Element|NodeList} - DOM element ID to scroll

offset=0 - {Number} - Controls the distance (negative or positive) between the top border of the element and the top border of the window.

silent=false - {Boolean} - If enabled, will generate a history.pushState event

First+Third

We build things... awesome things.

Versions

Version
2.2.1 Apr 18, 2021