cjsaylor/scrolltab

jQuery plugin to add tabs visually associated to their position relative to the scroll bar.

Scrolltab is a jQuery plugin that adds tabs visually associated to their position relative to the scroll bar.

This enables a developer to attach floating tabs to the scrollbar of the brwoser that will scroll the user to the position indicated by the tab. This tab is expandable with content within.

Demo

http://chris-saylor.com/Scrolltab/example.html

Install

There are two ways of installing:

1. Bower - bower install jquery-scrolltab

2. Download - You can install traditionally by downloading the minified version.

Options

• title: HTML to display within the pin
• classname: The classname for the pin to use
• mouseenter: function to execute when the mouseenter event fires on this pin
• mouseleave: function to execute when the mouseleave event fires on this pin
• click: function to execute when the click event fire on this pin

Setting Options via data attributes

You can set the title and classname of the pin via data attributes on the object.

<h4 class="scrolltab" data-st-title="Pin Title" data-st-classname="custom-pin-class">Title</h4>

Behaviors

The behavior of how the pin displays and hides is customizable by overriding the behavior functions.

Initial Display

When a new pin is created by the .scrolltab() call.

• Default behavior: fadeIn('slow')

$.fn.scrolltab.pinInitialDisplay

Display On Update

If the element the scrollpin was tracking becomes visible again, this will redisplay the pin.

• Default behavior: fadeIn('slow')

$.fn.scrolltab.pinDisplay

Pin Hide

If the element the scrollpin was tracking is hidden from the dom, this will hide the pin.

• Default behavior: fadeOut('fast')

$.fn.scrolltab.pinHide

Examples

	// Enables a pin with the default classname
	$('<dom object>').scrolltab();

	// Changes the classname of the created (or existing) pin
	$('<dom object>').scrolltab({ classname: 'test' });

	// Modifies the behavior of the click event on the pin
	$('<dom object').scrolltab({
		click: function (e) {
			e.preventDefault();
			alert('Pin clicked.')
		}
	});

	// Modify the initial behavior of pins showing on page load
	$.fn.scrolltab.pinInitialDisplay = function(pin) {
		// I don't want the fancy fadein affect.
		pin.show();
	};
	$('<dom object>').scrolltab();

	// Modify the default attributes of all pins created now on
	// In this example, I want all pins to have a click event function
	// callback attached.
	$.fn.scrolltab.default = $.extend($.fn.scrolltab.default, {
		click: function (e) {
			e.preventDefault();
			alert('Pin clicked!');
		}
	});
	$('<dom object>').scrolltab();

Build

Scrolltab uses Grunt CLI via NodeJS for linting and building the minified production file.

Setup

Install grunt cli globally:

$ npm install -g grunt-cli

Install dev dependencies:

$ npm install -d

Execute lint and build:

$ grunt

License

This software is protected under the MIT license.

scrolltab's Issues

Dom size trigger update bug

Changing document height is not correctly refreshing and updating the pin positions (or whether they should continue to exist).

Need to revisit objects that are pinned existence checks.

Add ability to set the title from the parent element.

View port size vs. document size

The tabs should not show (or be hidden) if the window size becomes larger or equal to the document size.

Remove reliance on `Math.random()` for pin ids.

Randomness is the wrong way to make unique IDs as there is a chance for ID collision. Switch to sequential numbering for the pin ID.