/*
jQuery selectBox (version 1.0.7)
A cosmetic, styleable replacement for SELECT elements.
Homepage: http://abeautifulsite.net/blog/2011/01/jquery-selectbox-plugin/
Demo page: http://labs.abeautifulsite.net/projects/js/jquery/selectBox/
Copyright 2011 Cory LaViska for A Beautiful Site, LLC.
Features:
- Supports OPTGROUPS
- Supports standard dropdown controls
- Supports multi-select controls (i.e. multiple="multiple")
- Supports inline controls (i.e. size="5")
- Fully accessible via keyboard
- Shift + click (or shift + enter) to select a range of options in multi-select controls
- Type to search when the control has focus
- Auto-height based on the size attribute (to use, omit the height property in your CSS!)
- Tested in IE7-IE9, Firefox 3-4, recent webkit browsers, and Opera
License:
Licensed under both the MIT license and the GNU GPLv2 (same as jQuery: http://jquery.org/license)
Usage:
Link to the JS file:
Add the CSS file (or append contents to your own stylesheet):
To create:
$("SELECT").selectBox([settings]);
Settings:
To specify settings, use this syntax: $("SELECT").selectBox('settings', { settingName: value, ... });
menuTransition: ['default', 'slide', 'fade'] - the show/hide transition for dropdown menus
menuSpeed: [integer, 'slow', 'normal', 'fast'] - the show/hide transition speed
loopOptions: [boolean] - flag to allow arrow keys to loop through options
Methods:
To call a method use this syntax: $("SELECT").selectBox('methodName', [options]);
create - Creates the control (default method)
destroy - Destroys the selectBox control and reverts back to the original form control
disable - Disables the control (i.e. disabled="disabled")
enable - Enables the control
value - if passed with a value, sets the control to that value; otherwise returns the current value
options - pass in either a string of HTML or a JSON object to replace the existing options
control - returns the selectBox control element (an anchor tag) for working with directly
Events:
Events are fired on the original select element. You can bind events like this:
$("SELECT").selectBox().change( function() { alert( $(this).val() ); } );
focus - Fired when the control gains focus
blur - Fired when the control loses focus
change - Fired when the value of a control changes
Change Log:
v1.0.0 (2011-04-03) - Complete rewrite with added support for inline and multi-select controls
v1.0.1 (2011-04-04) - Fixed options method so it doesn't destroy/recreate the control when called.
- Added a check for iOS devices (their native controls are much better for
touch-based devices; you can still use selectBox API methods for theme)
- Fixed issue where IE window would lose focus on XP
- Fixed premature selection issue in Webkit browsers
v1.0.2 (2011-04-13) - Fixed auto-height for inline controls when control is invisible on load
- Removed auto-width for dropdown and inline controls; now relies 100% on CSS
for setting the width
- Added 'control' method for working directly with the selectBox control
v1.0.3 (2011-04-22) - Fixed bug in value method that errored if the control didn't exist
v1.0.4 (2011-04-22) - Fixed bug where controls without any options would render with incorrect heights
v1.0.5 (2011-04-22) - Removed 'tick' image in lieu of background colors to indicate selection
- Clicking no longer toggles selected/unselected in multi-selects; use CTRL/CMD and
SHIFT like in normal browser controls
- Fixed bug where inline controls would not receive focus unless tabbed into
v1.0.6 (2011-04-29) - Fixed bug where inline controls could be "dragged" when selecting an empty area
v1.0.7 (2011-05-18) - Expanded iOS check to include Android devices as well
- Added autoWidth option; set to false on init to use CSS widths for dropdown menus
Known Issues:
- The blur and focus callbacks are not very reliable in IE7. The change callback works fine.
*/
if (jQuery) (function ($) {
$.extend($.fn, {
selectBox: function (method, data) {
var typeTimer, typeSearch = '';
//
// Private methods
//
var init = function (select, data) {
// Disable for iOS devices (their native controls are more suitable for a touch device)
if (navigator.userAgent.match(/iPad|iPhone|Android/i)) return false;
// Element must be a select control
if (select.tagName.toLowerCase() !== 'select') return false;
select = $(select);
if (select.data('selectBox-control')) return false;
var control = $(''),
inline = select.attr('multiple') || parseInt(select.attr('size')) > 1;
var settings = data || {};
if (settings.autoWidth === undefined) settings.autoWidth = true;
// Inherit class names, style, and title attributes
control
.addClass(select.attr('class'))
.attr('style', select.attr('style') || '')
.attr('title', select.attr('title') || '')
.attr('tabindex', parseInt(select.attr('tabindex')))
.css('display', 'inline-block')
.bind('focus.selectBox', function () {
if (this !== document.activeElement) $(document.activeElement).blur();
if (control.hasClass('selectBox-active')) return;
control.addClass('selectBox-active');
select.trigger('focus');
})
.bind('blur.selectBox', function () {
if (!control.hasClass('selectBox-active')) return;
control.removeClass('selectBox-active');
select.trigger('blur');
});
if (select.attr('disabled')) control.addClass('selectBox-disabled');
// Generate control
if (inline) {
//
// Inline controls
//
var options = getOptions(select, 'inline');
control
.append(options)
.data('selectBox-options', options)
.addClass('selectBox-inline selectBox-menuShowing')
.bind('keydown.selectBox', function (event) {
handleKeyDown(select, event);
})
.bind('keypress.selectBox', function (event) {
handleKeyPress(select, event);
})
.bind('mousedown.selectBox', function (event) {
if ($(event.target).is('A.selectBox-inline')) event.preventDefault();
if (!control.hasClass('selectBox-focus')) control.focus();
})
.insertAfter(select);
// Auto-height based on size attribute
if (!select[0].style.height) {
var size = select.attr('size') ? parseInt(select.attr('size')) : 5;
// Draw a dummy control off-screen, measure, and remove it
var tmp = control
.clone()
.removeAttr('id')
.css({
position: 'absolute',
top: '-9999em'
})
.show()
.appendTo('body');
tmp.find('.selectBox-options').html('
');
optionHeight = parseInt(tmp.find('.selectBox-options A:first').html(' ').outerHeight());
tmp.remove();
control.height(optionHeight * size);
}
disableSelection(control);
} else {
//
// Dropdown controls
//
var label = $(''),
arrow = $('');
// if a title attribute is set on the select, use it as an empty field value
var title = $(select).attr('title');
if (title != undefined && title != null && title != '') {
label.text(title || '\u00A0');
} else {
label.text($(select).find('OPTION:selected').text() || '\u00A0');
}
var options = getOptions(select, 'dropdown');
options.appendTo('BODY');
control
.data('selectBox-options', options)
.addClass('selectBox-dropdown')
.append(label)
.append(arrow)
.bind('mousedown.selectBox', function (event) {
if (control.hasClass('selectBox-menuShowing')) {
hideMenus();
} else {
event.stopPropagation();
// Webkit fix to prevent premature selection of options
options.data('selectBox-down-at-x', event.screenX).data('selectBox-down-at-y', event.screenY);
showMenu(select);
}
})
.bind('keydown.selectBox', function (event) {
handleKeyDown(select, event);
})
.bind('keypress.selectBox', function (event) {
handleKeyPress(select, event);
})
.insertAfter(select);
disableSelection(control);
}
// Store data for later use and show the control
select
.addClass('selectBox')
.data('selectBox-control', control)
.data('selectBox-settings', settings)
.hide();
};
var getOptions = function (select, type) {
var options;
switch (type) {
case 'inline':
options = $('
');
if (select.find('OPTGROUP').length) {
select.find('OPTGROUP').each(function () {
var optgroup = $('');
optgroup.text($(this).attr('label'));
options.append(optgroup);
generateOptions($(this).find('OPTION'), options);
});
} else {
generateOptions(select.find('OPTION'), options);
}
options
.find('A')
.bind('mouseover.selectBox', function (event) {
addHover(select, $(this).parent());
})
.bind('mouseout.selectBox', function (event) {
removeHover(select, $(this).parent());
})
.bind('mousedown.selectBox', function (event) {
event.preventDefault(); // Prevent options from being "dragged"
if (!select.selectBox('control').hasClass('selectBox-active')) select.selectBox('control').focus();
})
.bind('mouseup.selectBox', function (event) {
hideMenus();
selectOption(select, $(this).parent(), event);
});
disableSelection(options);
return options;
case 'dropdown':
options = $('
');
if (select.find('OPTGROUP').length) {
select.find('OPTGROUP').each(function () {
var optgroup = $('');
optgroup.text($(this).attr('label'));
options.append(optgroup);
generateOptions($(this).find('OPTION'), options);
});
} else {
if (select.find('OPTION').length > 0) {
generateOptions(select.find('OPTION'), options);
} else {
options.append('
\u00A0
');
}
}
options
.data('selectBox-select', select)
.css('display', 'none')
.appendTo('BODY')
.find('A')
.bind('mousedown.selectBox', function (event) {
event.preventDefault(); // Prevent options from being "dragged"
if (event.screenX === options.data('selectBox-down-at-x') && event.screenY === options.data('selectBox-down-at-y')) {
options.removeData('selectBox-down-at-x').removeData('selectBox-down-at-y');
hideMenus();
}
})
.bind('mouseup.selectBox', function (event) {
if (event.screenX === options.data('selectBox-down-at-x') && event.screenY === options.data('selectBox-down-at-y')) {
return;
} else {
options.removeData('selectBox-down-at-x').removeData('selectBox-down-at-y');
}
selectOption(select, $(this).parent());
hideMenus();
}).bind('mouseover.selectBox', function (event) {
addHover(select, $(this).parent());
})
.bind('mouseout.selectBox', function (event) {
removeHover(select, $(this).parent());
});
disableSelection(options);
return options;
}
};
var destroy = function (select) {
select = $(select);
var control = select.data('selectBox-control');
if (!control) return;
var options = control.data('selectBox-options');
options.remove();
control.remove();
select
.removeClass('selectBox')
.removeData('selectBox-control')
.removeData('selectBox-settings')
.show();
};
var showMenu = function (select) {
select = $(select);
var control = select.data('selectBox-control'),
settings = select.data('selectBox-settings'),
options = control.data('selectBox-options');
if (control.hasClass('selectBox-disabled')) return false;
hideMenus();
// Auto-width
if (settings.autoWidth) options.css('width', control.innerWidth());
else if (options.innerWidth() < control.innerWidth()) {
options.css('width', control.innerWidth() - parseInt(options.css('padding-left')) - parseInt(options.css('padding-right')))
}
var borderBottomWidth = isNaN(control.css('borderBottomWidth')) ? 0 : parseInt(control.css('borderBottomWidth'));
// Menu position
options.css({
top: control.offset().top + control.outerHeight() - borderBottomWidth,
left: control.offset().left
});
// Show menu
switch (settings.menuTransition) {
case 'fade':
options.fadeIn(settings.menuSpeed);
break;
case 'slide':
options.slideDown(settings.menuSpeed);
break;
default:
options.show(settings.menuSpeed);
break;
}
// Center on selected option
var li = options.find('.selectBox-selected:first');
keepOptionInView(select, li, true);
addHover(select, li);
control.addClass('selectBox-menuShowing');
$(document).bind('mousedown.selectBox', function (event) {
if ($(event.target).parents().andSelf().hasClass('selectBox-options')) return;
hideMenus();
});
};
var hideMenus = function () {
if ($(".selectBox-dropdown-menu").length === 0) return;
$(document).unbind('mousedown.selectBox');
$(".selectBox-dropdown-menu").each(function () {
var options = $(this),
select = options.data('selectBox-select'),
control = select.data('selectBox-control'),
settings = select.data('selectBox-settings');
switch (settings.menuTransition) {
case 'fade':
options.fadeOut(settings.menuSpeed);
break;
case 'slide':
options.slideUp(settings.menuSpeed);
break;
default:
options.hide(settings.menuSpeed);
break;
}
control.removeClass('selectBox-menuShowing');
});
};
var selectOption = function (select, li, event) {
select = $(select);
li = $(li);
var control = select.data('selectBox-control'),
settings = select.data('selectBox-settings');
if (control.hasClass('selectBox-disabled')) return false;
if (li.length === 0 || li.hasClass('selectBox-disabled')) return false;
if (select.attr('multiple')) {
// If event.shiftKey is true, this will select all options between li and the last li selected
if (event.shiftKey && control.data('selectBox-last-selected')) {
li.toggleClass('selectBox-selected');
var affectedOptions;
if (li.index() > control.data('selectBox-last-selected').index()) {
affectedOptions = li.siblings().slice(control.data('selectBox-last-selected').index(), li.index());
} else {
affectedOptions = li.siblings().slice(li.index(), control.data('selectBox-last-selected').index());
}
affectedOptions = affectedOptions.not('.selectBox-optgroup, .selectBox-disabled');
if (li.hasClass('selectBox-selected')) {
affectedOptions.addClass('selectBox-selected');
} else {
affectedOptions.removeClass('selectBox-selected');
}
} else if (event.metaKey) {
li.toggleClass('selectBox-selected');
} else {
li.siblings().removeClass('selectBox-selected');
li.addClass('selectBox-selected');
}
} else {
li.siblings().removeClass('selectBox-selected');
li.addClass('selectBox-selected');
}
if (control.hasClass('selectBox-dropdown')) {
control.find('.selectBox-label').text(li.text());
}
// Update original control's value
var i = 0, selection = [];
if (select.attr('multiple')) {
control.find('.selectBox-selected A').each(function () {
selection[i++] = $(this).attr('rel');
});
} else {
selection = li.find('A').attr('rel');
}
// Remember most recently selected item
control.data('selectBox-last-selected', li);
// Change callback
if (select.val() !== selection) {
select.val(selection);
select.trigger('change');
}
return true;
};
var addHover = function (select, li) {
select = $(select);
li = $(li);
var control = select.data('selectBox-control'),
options = control.data('selectBox-options');
options.find('.selectBox-hover').removeClass('selectBox-hover');
li.addClass('selectBox-hover');
};
var removeHover = function (select, li) {
select = $(select);
li = $(li);
var control = select.data('selectBox-control'),
options = control.data('selectBox-options');
options.find('.selectBox-hover').removeClass('selectBox-hover');
};
var keepOptionInView = function (select, li, center) {
if (!li || li.length === 0) return;
select = $(select);
var control = select.data('selectBox-control'),
options = control.data('selectBox-options'),
scrollBox = control.hasClass('selectBox-dropdown') ? options : options.parent(),
top = parseInt(li.offset().top - scrollBox.position().top),
bottom = parseInt(top + li.outerHeight());
if (center) {
scrollBox.scrollTop(li.offset().top - scrollBox.offset().top + scrollBox.scrollTop() - (scrollBox.height() / 2));
} else {
if (top < 0) {
scrollBox.scrollTop(li.offset().top - scrollBox.offset().top + scrollBox.scrollTop());
}
if (bottom > scrollBox.height()) {
scrollBox.scrollTop((li.offset().top + li.outerHeight()) - scrollBox.offset().top + scrollBox.scrollTop() - scrollBox.height());
}
}
};
var handleKeyDown = function (select, event) {
//
// Handles open/close and arrow key functionality
//
select = $(select);
var control = select.data('selectBox-control'),
options = control.data('selectBox-options'),
settings = select.data('selectBox-settings'),
totalOptions = 0,
i = 0;
if (control.hasClass('selectBox-disabled')) return;
switch (event.keyCode) {
case 8: // backspace
event.preventDefault();
typeSearch = '';
break;
case 9: // tab
case 27: // esc
hideMenus();
removeHover(select);
break;
case 13: // enter
if (control.hasClass('selectBox-menuShowing')) {
selectOption(select, options.find('LI.selectBox-hover:first'), event);
if (control.hasClass('selectBox-dropdown')) hideMenus();
} else {
showMenu(select);
}
break;
case 38: // up
case 37: // left
event.preventDefault();
if (control.hasClass('selectBox-menuShowing')) {
var prev = options.find('.selectBox-hover').prev('LI');
totalOptions = options.find('LI:not(.selectBox-optgroup)').length;
i = 0;
while (prev.length === 0 || prev.hasClass('selectBox-disabled') || prev.hasClass('selectBox-optgroup')) {
prev = prev.prev('LI');
if (prev.length === 0) {
if (settings.loopOptions) {
prev = options.find('LI:last');
} else {
prev = options.find('LI:first');
}
}
if (++i >= totalOptions) break;
}
addHover(select, prev);
selectOption(select, prev, event);
keepOptionInView(select, prev);
} else {
showMenu(select);
}
break;
case 40: // down
case 39: // right
event.preventDefault();
if (control.hasClass('selectBox-menuShowing')) {
var next = options.find('.selectBox-hover').next('LI');
totalOptions = options.find('LI:not(.selectBox-optgroup)').length;
i = 0;
while (next.length === 0 || next.hasClass('selectBox-disabled') || next.hasClass('selectBox-optgroup')) {
next = next.next('LI');
if (next.length === 0) {
if (settings.loopOptions) {
next = options.find('LI:first');
} else {
next = options.find('LI:last');
}
}
if (++i >= totalOptions) break;
}
addHover(select, next);
selectOption(select, next, event);
keepOptionInView(select, next);
} else {
showMenu(select);
}
break;
}
};
var handleKeyPress = function (select, event) {
//
// Handles type-to-find functionality
//
select = $(select);
var control = select.data('selectBox-control'),
options = control.data('selectBox-options');
if (control.hasClass('selectBox-disabled')) return;
switch (event.keyCode) {
case 9: // tab
case 27: // esc
case 13: // enter
case 38: // up
case 37: // left
case 40: // down
case 39: // right
// Don't interfere with the keydown event!
break;
default: // Type to find
if (!control.hasClass('selectBox-menuShowing')) showMenu(select);
event.preventDefault();
clearTimeout(typeTimer);
typeSearch += String.fromCharCode(event.charCode || event.keyCode);
options.find('A').each(function () {
if ($(this).text().substr(0, typeSearch.length).toLowerCase() === typeSearch.toLowerCase()) {
addHover(select, $(this).parent());
keepOptionInView(select, $(this).parent());
return false;
}
});
// Clear after a brief pause
typeTimer = setTimeout(function () { typeSearch = ''; }, 1000);
break;
}
};
var enable = function (select) {
select = $(select);
select.attr('disabled', false);
var control = select.data('selectBox-control');
if (!control) return;
control.removeClass('selectBox-disabled');
};
var disable = function (select) {
select = $(select);
select.attr('disabled', true);
var control = select.data('selectBox-control');
if (!control) return;
control.addClass('selectBox-disabled');
};
var setValue = function (select, value) {
select = $(select);
select.val(value);
value = select.val();
var control = select.data('selectBox-control');
if (!control) return;
var settings = select.data('selectBox-settings'),
options = control.data('selectBox-options');
// Update label
control.find('.selectBox-label').text($(select).find('OPTION:selected').text() || '\u00A0');
// Update control values
options.find('.selectBox-selected').removeClass('selectBox-selected');
options.find('A').each(function () {
if (typeof (value) === 'object') {
for (var i = 0; i < value.length; i++) {
if ($(this).attr('rel') == value[i]) {
$(this).parent().addClass('selectBox-selected');
}
}
} else {
if ($(this).attr('rel') == value) {
$(this).parent().addClass('selectBox-selected');
}
}
});
if (settings.change) settings.change.call(select);
};
var setOptions = function (select, options) {
select = $(select);
var control = select.data('selectBox-control'),
settings = select.data('selectBox-settings');
switch (typeof (data)) {
case 'string':
select.html(data);
break;
case 'object':
select.html('');
for (var i in data) {
if (data[i] === null) continue;
if (typeof (data[i]) === 'object') {
var optgroup = $('');
for (var j in data[i]) {
optgroup.append('');
}
select.append(optgroup);
} else {
var option = $('');
select.append(option);
}
}
break;
}
if (!control) return;
// Remove old options
control.data('selectBox-options').remove();
// Generate new options
var type = control.hasClass('selectBox-dropdown') ? 'dropdown' : 'inline',
options = getOptions(select, type);
control.data('selectBox-options', options);
switch (type) {
case 'inline':
control.append(options);
break;
case 'dropdown':
control.find('.selectBox-label').text($(select).find('OPTION:selected').text() || '\u00A0');
$("BODY").append(options);
break;
}
};
var disableSelection = function (selector) {
$(selector)
.css('MozUserSelect', 'none')
.bind('selectstart', function (event) {
event.preventDefault();
});
};
var generateOptions = function (originalOptions, options) {
originalOptions.each(function (i) {
var self = $(this);
var li = $('');
if (i === originalOptions.length - 1) {
li = $('');
}
var a = $('');
li.addClass(self.attr('class'));
li.data(self.data());
a.attr('rel', self.val()).text(self.text());
li.append(a);
if (self.attr('disabled')) li.addClass('selectBox-disabled');
if (self.attr('selected')) li.addClass('selectBox-selected');
options.append(li);
})
};
//
// Public methods
//
switch (method) {
case 'control':
return $(this).data('selectBox-control');
break;
case 'settings':
if (!data) return $(this).data('selectBox-settings');
$(this).each(function () {
$(this).data('selectBox-settings', $.extend(true, $(this).data('selectBox-settings'), data));
});
break;
case 'options':
$(this).each(function () {
setOptions(this, data);
});
break;
case 'value':
// Empty string is a valid value
if (data === undefined) return $(this).val();
$(this).each(function () {
setValue(this, data);
});
break;
case 'enable':
$(this).each(function () {
enable(this);
});
break;
case 'disable':
$(this).each(function () {
disable(this);
});
break;
case 'destroy':
$(this).each(function () {
destroy(this);
});
break;
default:
$(this).each(function () {
init(this, method);
});
break;
}
return $(this);
}
});
})(jQuery);