@pluginjs/scroll-to

ScrollTo

A flexible modern scroll-to js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/scroll-to

NPM

npm i @pluginjs/scroll-to

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.css">

Production:

<script src="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import ScrollTo from "@pluginjs/scroll-to"
import "@pluginjs/scroll-to/dist/scroll-to.css"

ScrollTo.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/scroll-to/dist/scroll-to.css")
const ScrollTo = require("@pluginjs/scroll-to")

ScrollTo.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.css">
<script src="https://unpkg.com/@pluginjs/scroll-to/dist/scroll-to.js"></script>
<script>
  Pj.scrollTo('.element', options)
</script>

API

Options

Options are called on scrollTo instances through the scrollTo options itself. You can also save the instances to variable for further use.

Name	Description	Default
"selector"	Set selector	[data-scrollto]
"href"	Set href	data-scrollto
"duration"	Set duretion	500
"easing"	Set easting	ease
"offsetTop"	Set offsetTop	50
"mobile"	Set mobile	{"width":768,"duration":500,"easing":"ease"}

Events

Events are called on scrollTo instances through the scrollTo events itself. You can also save the instances to variable for further use.

Name	Description
"ready"	Gets fired when plugin has ready
"enable"	Gets fired when plugin has enabled
"disable"	Gets fired when plugin has disabled
"destroy"	Gets fired when plugin has destroy
"jump"	Gets fired when plugin has jump
"done"	Gets fired when plugin has done

Methods

Methods are called on scrollTo instances through the scrollTo method itself. You can also save the instances to variable for further use.

Name	Description
"jump"	Set jump function
"enable"	Enabled plugin if plugin is disabled
"disable"	Disable plugin
"destroy"	Destroy plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-scrollTo "ACTIVE" | Announce plugin is actived | {namespace}-active "ANIMATING" | Declare plugin animating | {namespace}-animating

Browser support

Tested on all major browsers.

IE / Edge	Firefox	Chrome	Safari	Opera
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

License

@pluginjs/scroll-to is Licensed under the GPL-v3 license.

If you want to use @pluginjs/scroll-to project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [e-mail].

Copyright

Copyright (C) 2022 Creation Studio Limited.