YUI Library Examples: Event Utility: Skinning via Progressive Enhancement using the Event Utility and the YUILoader

Challenges

There are a few challenges when trying to skin an HTML checkbox using CSS. To start, most of the A-grade browsers don't provide support for CSS properties like border and background on the <input type="checkbox"> element. Additionally, IE 6 and IE 7 (Quirks Mode) lack support for attribute selectors — necessary to style the checked and disabled states. Additionally, IE 6 and 7 only support the :focus and :active pseudo classes on <a> elements, both of which are needed to style a checkbox when it is focused or depressed.

Approach

Despite the shortcomings in cross-browser CSS support, with a little extra markup and through the use of JavaScript it is possible to skin an <input type="checkbox"> element consistently well in all of the A-grade browsers.

Markup

Since CSS support for the <input type="checkbox"> element is lacking, wrap <input type="checkbox"> elements in one or more inline elements to provide the necessary hooks for styling. In this example, each <input type="checkbox"> element is wrapped by two <span>s.

CSS

To style each checkbox, a class name of yui-checkbox will be applied to the outtermost <span> wrapping each <input type="checkbox"> element. An additional class will be used to represent the various states of each checkbox. The class name for each state will follow a consistent pattern: yui-checkbox-[state]. For this example, the following state-based class names will be used:

yui-checkbox-focus: The checkbox has focus
yui-checkbox-active: The checkbox is active (pressed)
yui-checkbox-checked: The checkbox is checked

The styles for each checkbox comes together as follows:

.yui-checkbox {

display: -moz-inline-stack;	/* Gecko < 1.9, since it doesn't support "inline-block" */
	display: inline-block; /* IE, Opera and Webkit, and Gecko 1.9 */
	width: 10px;
	height: 10px;
	border: inset 2px #999;
	background-color: #fff;	/*	Need to set a background color or IE won't get mouse events	*/

/*
		Necessary for IE 6 (Quirks and Standards Mode) and IE 7 (Quirks Mode), since 
		they don't support use of negative margins without relative positioning.  
	*/

_position: relative;
}

.yui-checkbox span {

display: block;
	height: 14px;
	width: 12px;
	overflow: hidden;

/* Position the checkmark for Gecko, Opera and Webkit and IE 7 (Strict Mode). */
	margin: -5px 0 0 1px;

/* Position the checkmark for IE 6 (Strict and Quirks Mode) and IE 7 (Quirks Mode).*/
	_margin: 0;
	_position: absolute;
	_top: -5px;
	_left: 1px;
	
}

/* For Gecko < 1.9: Positions the checkbox on the same line as its corresponding label. */
.yui-checkbox span:after {

content: ".";
	visibility: hidden;
	line-height: 2;

}

/*
	Hide the actual checkbox offscreen so that it is out of view, but still accessible via 
	the keyboard. 
*/
.yui-checkbox input {

position: absolute;
	left: -10000px;

}

.yui-checkbox-focus {

border-color: #39f;
	background-color: #9cf;

}

.yui-checkbox-active {

background-color: #ccc;

}

.yui-checkbox-checked span {

/* Draw a custom checkmark for the checked state using a background image. */
	background: url(checkmark.png) no-repeat;

}

JavaScript

Application and removal of the state-based class names will be facilitated by JavaScript event handlers. Each event handler will track the state of the <input type="checkbox"> element, and apply and remove corresponding state-based class names from its outtermost <span> — making it easy to style each state. And since each JavaScript is required for state management, the stylesheet for the skinned checkboxes will only be added to the page when JavaScript is enabled. This will ensure that each checkbox works correctly with and without JavaScript enabled.

Since there could easily be many instances of a skinned checkbox on the page, all event listeners will be attached to the containing element for all checkboxes. Each listener will listen for events as they bubble up from each checkbox. Relying on event bubbling will improve the overall performance of the page by reducing the number of event handlers.

Since the DOM focus and blur events do not bubble, use the Event Utility's specialized focusin and focusout events as an alternative to attaching discrete focus and blur event handlers to the <input type="checkbox"> element of each skinned checkbox. The specialized focusin and focusout events make it possible to attach a single focus and blur event listener on the containing element of each checkbox — thereby increasing the performance of the page. The complete script for the example comes together as follows:

(function () {

var Event = YAHOO.util.Event,
		Dom = YAHOO.util.Dom,
		Selector = YAHOO.util.Selector,
		UA = YAHOO.env.ua,

bKeyListenersInitialized = false,
		bMouseListenersInitialized = false,
		sCheckboxFocusClass = "yui-checkbox-focus",
		sCheckboxCheckedClass = "yui-checkbox-checked",
		sCheckboxActiveClass = "yui-checkbox-active",
		forAttr = (UA.ie && UA.ie < 8) ? "htmlFor" : "for",
		bBlockDocumentMouseUp = false,
		bBlockClearActive = false,
		bBlockBlur = false,
		oActiveCheckbox;

var initKeyListeners = function () {

Event.delegate(this, "keydown", onCheckboxKeyDown, ".yui-checkbox");
		Event.delegate(this, "click", onCheckboxClick, ".yui-checkbox");
		Event.delegate(this, "focusout", onCheckboxBlur, "input[type=checkbox]");

bKeyListenersInitialized = true;

};

var initMouseListeners = function () {

Event.delegate(this, "mouseover", onCheckboxMouseOver, ".yui-checkbox");
		Event.delegate(this, "mouseout", onCheckboxMouseOut, ".yui-checkbox-active");
		Event.on(this.ownerDocument, "mouseup", onDocumentMouseUp);

bMouseListenersInitialized = true;

};

var getCheckbox = function (node) {

return (Dom.hasClass(node, "yui-checkbox") ? node: 
					Dom.getAncestorByClassName(node, "yui-checkbox"));

};

var getCheckboxForLabel = function (label) {

var sID = label.getAttribute(forAttr),
			oInput,
			oCheckbox;

if (sID) {

oInput = Dom.get(sID);

if (oInput) {
				oCheckbox = getCheckbox(oInput);
			}

}

return oCheckbox;

};

var updateCheckedState = function (input) {

var oCheckbox = getCheckbox(input);

if (input.checked) {
			Dom.addClass(oCheckbox, sCheckboxCheckedClass);
		}
		else {
			Dom.removeClass(oCheckbox, sCheckboxCheckedClass);
		}

};

var setActiveCheckbox = function (checkbox) {

Dom.addClass(checkbox, sCheckboxActiveClass);
		oActiveCheckbox = checkbox;

};

var clearActiveCheckbox = function () {

if (oActiveCheckbox) {
			Dom.removeClass(oActiveCheckbox, sCheckboxActiveClass);
			oActiveCheckbox = null;
		}

};

var onCheckboxMouseOver = function (event, matchedEl) {

if (oActiveCheckbox === matchedEl) {
			Dom.addClass(oActiveCheckbox, sCheckboxActiveClass);
		}

};

var onCheckboxMouseOut = function (event, matchedEl) {

Dom.removeClass(matchedEl, sCheckboxActiveClass);

};

var onDocumentMouseUp = function (event) {

var oCheckbox;

if (!bBlockDocumentMouseUp) {

oCheckbox = getCheckbox(Event.getTarget(event));

if ((oCheckbox && oActiveCheckbox !== oCheckbox) || !oCheckbox) {
				clearActiveCheckbox();
			}

}

bBlockDocumentMouseUp = false;

};

var onCheckboxFocus = function (event, matchedEl, container) {

//	Remove the focus style from any checkbox that might still have it

var oCheckbox = Selector.query(".yui-checkbox-focus", "checkboxes", true);

if (oCheckbox) {
			Dom.removeClass(oCheckbox, sCheckboxFocusClass);
		}

//	Defer adding key-related and click event listeners until 
		//	one of the checkboxes is initially focused.

if (!bKeyListenersInitialized) {
			initKeyListeners.call(container);
		}

oCheckbox = getCheckbox(matchedEl);

Dom.addClass(oCheckbox, sCheckboxFocusClass);

};

var onCheckboxBlur = function (event, matchedEl) {

if (bBlockBlur) {
			bBlockBlur = false;
			return;
		}

var oCheckbox = getCheckbox(matchedEl);

Dom.removeClass(oCheckbox, sCheckboxFocusClass);

if (!bBlockClearActive && oCheckbox === oActiveCheckbox) {
			clearActiveCheckbox();
		}

bBlockClearActive = false;

};

var onCheckboxMouseDown = function (event, matchedEl, container) {

//	Defer adding mouse-related and click event listeners until 
		//	the user mouses down on one of the checkboxes.

if (!bMouseListenersInitialized) {
			initMouseListeners.call(container);
		}

var oCheckbox,
			oInput;

if (matchedEl.nodeName.toLowerCase() === "label") {

//	If the target of the event was the checkbox's label element, the
			//	label will dispatch a click event to the checkbox, meaning the 
			//	"onCheckboxClick" handler will be called twice.  For that reason
			//	it is necessary to block the "onDocumentMouseUp" handler from
			//	clearing the active state, so that a reference to the active  
			//	checkbox still exists the second time the "onCheckboxClick"
			//	handler is called.

bBlockDocumentMouseUp = true;

//	When the user clicks the label instead of the checkbox itself, 
			//	the checkbox will be blurred if it has focus.  Since the 
			//	"onCheckboxBlur" handler clears the active state it is 
			//	necessary to block the clearing of the active state when the 
			//	label is clicked instead of the checkbox itself.

bBlockClearActive = true;

oCheckbox = getCheckboxForLabel(matchedEl);

}
		else {

oCheckbox = matchedEl;

}

//	Need to focus the input manually for two reasons:
		//	1) 	Mousing down on a label in Webkit doesn't focus its  
		//		associated checkbox
		//	2)	By default checkboxes are focused when the user mouses 
		//		down on them.  However, since the actually checkbox is 
		//		obscurred by the two span elements that are used to 
		//		style it, the checkbox wont' receive focus as it was 
		//		never the actual target of the mousedown event.

oInput = Selector.query("input", oCheckbox, true);

//	Calling Event.preventDefault won't block the blurring of the 
		//	currently focused element in IE, so we'll use the "bBlockBlur"
		//	variable to stop the code in the blur event handler  
		//	from executing.

bBlockBlur = (UA.ie && document.activeElement == oInput);

oInput.focus();

setActiveCheckbox(oCheckbox);

//	Need to call preventDefault because by default mousing down on
		//	an element will blur the element in the document that currently 
		//	has focus--in this case, the input element that was 
		//	just focused.

Event.preventDefault(event);

};

var onCheckboxClick = function (event, matchedEl) {

var oTarget = Event.getTarget(event),
			oInput;

if (matchedEl === oActiveCheckbox) {

oInput = Selector.query("input", matchedEl, true);

if (oTarget !== oInput) {

//	If the click event was fired via the mouse the checked
				//	state will have to be manually updated since the input 
				//	is hidden offscreen and therefore couldn't be the 
				//	target of the click.

oInput.checked = (!oInput.checked);

}

updateCheckedState(oInput);
			clearActiveCheckbox();

}

};

var onCheckboxKeyDown = function (event, matchedEl) {

//	Style the checkbox as being active when the user presses the 
		//	space bar

if (Event.getCharCode(event) === 32) {
			setActiveCheckbox(matchedEl);						
		}

};

var checkboxes = Selector.query("#checkboxes>div>span");

for (var i = checkboxes.length - 1; i >= 0; i--) {
		Dom.addClass(checkboxes[i], "yui-checkbox");
	}

//	Remove the "yui-checkboxes-loading" class used to hide the 
	//	checkboxes now that the checkboxes have been skinned.

document.documentElement.className = "";

//	Add the minimum number of event listeners needed to start, bind the 
	//	rest when needed

Event.delegate("checkboxes", "mousedown", onCheckboxMouseDown, ".yui-checkbox,label");
	Event.delegate("checkboxes", "focusin", onCheckboxFocus, "input[type=checkbox]");

}());

Progressive Enhancement

The markup above will be transformed using both CSS and JavaScript. To account for the scenario where the user has CSS enabled in their browser but JavaScript is disabled, the CSS used to style the checkboxes will be loaded via JavaScript using the YUI Loader. Additionally, a small block of JavaScript will be placed in the <head> — used to temporarily hide the markup while the JavaScript and CSS are in the process of loading to prevent the user from seeing a flash unstyled content.

YUI Logger Output:

Note: Logging and debugging is currently turned off for this example.

Reload with logging
and debugging enabled.

Event Utility Examples:

More Event Utility Resources:

All YUI 2.x users should review the YUI 2.8.2 security bulletin, which discusses a vulnerability present in YUI 2.4.0-2.8.1.