jQuery scrollTo

A jquery plugin that click on the button to jump to the specified location.

Table of contents

• Main files
• Quick start
• Requirements
• Usage
• Examples
• Options
• Methods
• Events
• No conflict
• Browser support
• Contributing
• Development
• Changelog
• Copyright and license

Main files

dist/
├── jquery-scrollTo.js
├── jquery-scrollTo.es.js
├── jquery-scrollTo.min.js
└── css/
    ├── scrollTo.css
    └── scrollTo.min.css

Quick start

Several quick start options are available:

Download the latest build

• Development - unminified
• Production - minified

Install From Bower

bower install jquery-scrollTo --save

Install From Npm

npm install jquery-scrollTo --save

Install From Yarn

yarn add jquery-scrollTo

Build From Source

If you want build from source:

git clone [email protected]:amazingSurge/jquery-scrollTo.git
cd jquery-scrollTo
npm install
npm install -g gulp-cli babel-cli
gulp build

Done!

Requirements

jquery-scrollTo requires the latest version of jQuery.

Usage

Including files:

<link rel="stylesheet" href="/path/to/scrollTo.css">
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-scrollTo.js"></script>

Required HTML structure

<div class="nav">
  <li data-scrollto="hello">#hello</li>
  <li data-scrollto="world">#world</li>
</div>

Initialization

All you need to do is call the plugin on the element:

jQuery(function($) {
  $(".nav").scrollTo();
});

Examples

There are some example usages that you can look at to get started. They can be found in the examples folder.

Options

jquery-scrollTo can accept an options object to alter the way it behaves. You can see the default options by call $.scrollTo.setDefaults(). The structure of an options object is as follows:

{
  speed: '1000',
  easing: 'linear',
  namespace: 'scrollTo',
  offsetTop: 50,
  mobile: {
    width: 768,
    speed: '500',
    easing: 'linear',
  }
}

Methods

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

// call directly
$().scrollTo('jump');

// or
var api = $().data('scrollTo');
api.jump();

jump()

Jump to the target

$().scrollTo('jump');

destroy()

Destroy the scrollbar instance.

$().scrollTo('destroy');

Events

jquery-scrollTo provides custom events for the plugin’s unique actions.

$(document).on('scrollTo::jump', function (e) {
  // on instance ready
});

Event	Description
scrollTo::jump	Fires when the jump instance method has been called.

No conflict

If you have to use other plugin with the same namespace, just call the $.scrollTo.noConflict method to revert to it.

<script src="other-plugin.js"></script>
<script src="jquery-scrollTo.js"></script>
<script>
  $.scrollTo.noConflict();
  // Code that uses other plugin's "$().scrollTo" can follow here.
</script>

Browser support

Tested on all major browsers.

Latest ✓	Latest ✓	Latest ✓	Latest ✓	9-11 ✓	Latest ✓

As a jQuery plugin, you also need to see the jQuery Browser Support.

Contributing

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing. Make sure you're using the latest version of jquery-scrollTo before submitting an issue. There are several ways to help out:

• Bug reports
• Feature requests
• Pull requests
• Write test cases for open bug issues
• Contribute to the documentation

Development

jquery-scrollTo is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:

npm install -g gulp
npm install -g babel-cli
npm install

Then you can generate new distributable files from the sources, using:

gulp build

More gulp tasks can be found here.

Changelog

To see the list of recent changes, see Releases section.

Copyright and license

Copyright (C) 2016 amazingSurge.

Licensed under the LGPL license.

⬆ back to top