suave.js

/*
 *  Suave makes it easier to apply smooth vertical scrolling to all of the same-page
 *	links on your website. Simply pass in all anchor tags and you are set. You can 
 *	also select specific classes or IDs if you don't need it on all links. I'm working
 *	on adding support for horizontal scrolling and also to make Suave more 
 *	customizable. Stay tuned
 *
 *      Suave requires jQuery to work.
 *
 *
 *      by Enrique Gonzalez (Enriikke)
 *      helloimenrique.com
 *      enrique@chiibo.com
 *
 *      enjoy!
 *
 */
(function ($) {
	
	$.fn.suave = function(options) {

		// Customizable settings for Suave
		var settings = $.extend({

			speed: 				400, // How fast should the animation be
			displayURL: 		false, // Display the link hash in the URL bar
			horizontalScroll: 	false // Allow for horizontal scrolling

		}, options);



		/****************************************************************************************************
        		NICE UTIL FUNCTIONS FOR VAPE TO WORK 
        *****************************************************************************************************/

		// TODO: Need to filterout the target
		var getTarget = function(anchor) {

			if(	anchor.hash.replace(/#/, '') &&
				anchor.hostname == location.hostname &&
				anchor.pathname == location.pathname ) return anchor.hash;


			return false;

		};


		// TODO: test the location
		var setHash = function(target) {

			location.hash = target;
		};



		/****************************************************************************************************
                THE MAGIC HAPPENS HERE 
        *****************************************************************************************************/
                
		return this.each(function() {
			var target = getTarget(this);
			if(!target) return true;

			$(this).click(function (event) {
				event.preventDefault();

				var offset = $(target).offset().top;
				$('html, body').animate({scrollTop: offset}, settings.speed, function() {
					if(settings.displayURL) setHash(target);
				});
			});
		});
	};

})(jQuery);