https://github.com/flesler/jquery.localScroll

Animated anchor navigation made easy with jQuery
https://github.com/flesler/jquery.localScroll

anchor animated hash jquery navigation plugin scrolling scrollto

Last synced: 3 months ago
JSON representation

Animated anchor navigation made easy with jQuery

• Host: GitHub
• URL: https://github.com/flesler/jquery.localScroll
• Owner: flesler
• License: mit
• Created: 2012-06-10T18:14:17.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2017-09-05T17:35:48.000Z (over 7 years ago)
• Last Synced: 2024-10-14T10:49:21.331Z (4 months ago)
• Topics: anchor, animated, hash, jquery, navigation, plugin, scrolling, scrollto
• Language: JavaScript
• Homepage: http://demos.flesler.com/jquery/localScroll/
• Size: 46.9 KB
• Stars: 615
• Watchers: 42
• Forks: 197
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# jQuery.localScroll

Animated anchor navigation made easy with jQuery

### Demo

You can check the [demo](http://demos.flesler.com/jquery/localScroll/) to see the plugin in action.

### Installation and usage

Via [bower](https://github.com/flesler/jquery.localScroll/blob/master/bower.json):

```bash

bower install jquery.localScroll

```

Via [npm](https://www.npmjs.com/package/jquery.localscroll):

```bash

npm install jquery.localscroll

```

### Using a public CDN

CDN provided by [jsdelivr](http://www.jsdelivr.com/#!jquery.localscroll)

```html

```

CDN provided by [cdnjs](https://cdnjs.com/libraries/jquery-localScroll) (outdated)

```html

```

### Downloading Manually

You can get the latest stable version from the [releases page](https://github.com/flesler/jquery.localScroll/releases).

### Demo

You can see the plugin in a (somewhat precarious) [demo page](http://demos.flesler.com/jquery/localScroll/).

### jQuery.scrollTo

This plugin requires [jQuery.scrollTo](http://github.com/flesler/jquery.scrollTo).

In order to use jQuery.scrollTo 2.0 you need to update jQuery.localScroll to 1.4.0 and above.

### Notes

* The hash of settings is passed in to jQuery.scrollTo, so, in addition to jQuery.localScroll's settings, you can use any of jQuery.scrollTo's. Check that plugin's documentation for further information.

* If you want to convert the links from ALL over the page, with the same settings, just call $.localScroll(...) instead of $(...).localScroll(...)

* Most of this plugin's defaults, belong to jQuery.scrollTo, check it's demo for an example of each option.