https://github.com/davist11/jQuery-One-Page-Nav

Smooth scrolling and smart navigation when user scrolls on one-page sites.
https://github.com/davist11/jQuery-One-Page-Nav

Last synced: 16 days ago
JSON representation

Smooth scrolling and smart navigation when user scrolls on one-page sites.

• Host: GitHub
• URL: https://github.com/davist11/jQuery-One-Page-Nav
• Owner: davist11
• License: mit
• Archived: true
• Created: 2010-09-26T03:31:51.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2020-09-16T12:22:56.000Z (about 4 years ago)
• Last Synced: 2024-04-29T21:09:56.413Z (7 months ago)
• Language: HTML
• Homepage: http://davist11.github.com/jQuery-One-Page-Nav/
• Size: 129 KB
• Stars: 1,526
• Watchers: 87
• Forks: 502
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A lightweight jQuery plugin for the navigation on one-page sites. Adds smooth scrolling when clicking on the navigation and automatically selects the correct navigation items as you are scrolling through the different sections.

The plugin still works even if you add additional content to the page after the fact that changes the position of each section.

### Sample Markup:

<ul id="nav">

	<li class="current"><a href="#section-1">Section 1</a></li>

	<li><a href="#section-2">Section 2</a></li>

	<li><a href="#section-3">Section 3</a></li>

</ul>


<div id="section-1">

	<strong>Section 1</strong>

	<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>

</div>

<div id="section-2">

	<strong>Section 2</strong>

	<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>

</div>

<div id="section-3">

	<strong>Section 3</strong>

	<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>

</div>


### Example Usage with Defaults:

$('#nav').onePageNav({

	currentClass: 'current',

	changeHash: false,

	scrollSpeed: 750,

	scrollThreshold: 0.5,

	filter: '',

	easing: 'swing',

	begin: function() {

		//I get fired when the animation is starting

	},

	end: function() {

		//I get fired when the animation is ending

	},

	scrollChange: function($currentListItem) {

		//I get fired when you enter a section and I pass the list item of the section

	}

});


If you want the hash to change when a user clicks on the navigation, then change the **changeHash** options to **true**.

If you want to filter items out of your navigation then pass in a selector to the filter option.

### Filter Example:

<ul id="nav">

	<li class="current"><a href="#section-1">Section 1</a></li>

	<li><a href="#section-2">Section 2</a></li>

	<li><a href="#section-3">Section 3</a></li>

	<li><a href="#section-4">Section 4</a></li>

	<li><a href="#section-5">Section 5</a></li>

	<li><a href="http://google.com" class="external">Some other link</a></li>

</ul>


$('#nav').onePageNav({

	filter: ':not(.external)'

});


### Offset

In a previous version, there was an offset option to pass into the JavaScript. This was abandoned in favor of a CSS-only solution which simplified the code and makes it easier to handle responsively. [Example](http://davist11.github.io/jQuery-One-Page-Nav/top.html)

### If you are having issues with iOS devices

If clicking a link in the nav makes the rest of the links unclickable until you scroll, you can solve it in this hacky way:

$('#nav').onePageNav({

	begin: function() {

		//Hack so you can click other menu items after the initial click

		$('body').append('<div id="device-dummy" style="height: 1px;"></div>');

	},

	end: function() {

		$('#device-dummy').remove();

	}

});


Found the solution [here](http://stackoverflow.com/a/10030251)