Getting Started

The StyleSheet Utility's only dependency is the Yahoo Global Object. To use the StyleSheet Utility, include the following source files in your web page:

<!-- Dependencies --> <script type="text/javascript" src="http://yui.yahooapis.com/2.8.0r4/build/yahoo/yahoo-min.js" ></script> <script type="text/javascript" src="http://yui.yahooapis.com/2.8.0r4/build/stylesheet/stylesheet-min.js"></script>

Using the StyleSheet Utility

This section will address how to create and use YAHOO.util.StyleSheet instances and includes:

• Instantiating a YAHOO.util.StyleSheet
• Getting a StyleSheet by registered name
• Creating and modifying CSS style rules
• Removing and resetting CSS style rules
• A note on selector strings
• Disabling and enabling a StyleSheet
• Support for method chaining
• Static methods

Instantiating a YAHOO.util.StyleSheet

The YAHOO.util.StyleSheet constructor is written to support both function syntax and normal constructor syntax making the new prefix unnecessary, but harmless.

The constructor has no required parameters. Passing no arguments will create a new empty StyleSheet.

// These are equivalent; both create new empty StyleSheets var myStyleSheet = new YAHOO.util.StyleSheet(); var myOtherStyleSheet = YAHOO.util.StyleSheet();

To seed a new StyleSheet with a number of CSS rules, you can pass the constructor any of the following:

1. a <style> or <link> node reference,
2. the id of a <style> or <link> node, or
3. a string of CSS

<link id="local" type="text/css" rel="stylesheet" href="local_file.css"> <style type="text/css"> .some select.or { margin-right: 2em; } </style> <script type="text/javascript"> (function () { // style element or locally sourced link element var sheet = YAHOO.util.StyleSheet(YAHOO.util.Selector.query('style',null,true)); sheet = YAHOO.util.StyleSheet(YAHOO.util.Dom.get('local')); // OR the id of a style element or locally sourced link element sheet = YAHOO.util.StyleSheet('local'); // OR string of css text var css = ".moduleX .alert { background: #fcc; font-weight: bold; } " + ".moduleX .warn { background: #eec; } " + ".hide_messages .moduleX .alert, " + ".hide_messages .moduleX .warn { display: none; }"; sheet = new YAHOO.util.StyleSheet(css); ... })(); </script>

Be aware that the Same Origin policy prevents access to the style data of <link> elements with hrefs pointing to other domains. Attempts to seed a YAHOO.util.StyleSheet instance with a cross-domain <link> will result in a security error.

<link id="remote" type="text/css" rel="stylesheet" href="http://other.domain.com/remote_file.css"> <script type="text/javascript"> // ERROR - Same Origin Policy prevents access to remote stylesheets YAHOO.MyApp.styleSheet = YAHOO.util.StyleSheet('remote'); </script>

Getting a StyleSheet by registered name

YAHOO.util.StyleSheet supports registering instances by name allowing them to be recalled by that same name elsewhere in your code. Internally YAHOO.util.StyleSheet maintains a registry of all created StyleSheet instances, using a unique generated id that the host node is tagged with. This allows future attempts to create a StyleSheet instance from the same node to return the previously created instance associated with that id.

Register a StyleSheet instance manually using the static register method or pass the desired name as a second parameter to the constructor.

var sheetA = YAHOO.util.StyleSheet(YAHOO.util.Dom.get('my_stylesheet')); // Create a registry alias to sheetA. We'll call it bob. YAHOO.util.StyleSheet.register(sheetA, 'bob'); // Create another StyleSheet passing the name as the second parameter var css = ".some .css { white-space: pre-wrap; color: pink; }"; var sheetB = YAHOO.util.StyleSheet(css, 'my sheet'); // Meanwhile, elsewhere in your code // sheetA is the same instance as sheet1 and sheet2 var sheet1 = YAHOO.util.StyleSheet(YAHOO.util.Dom.get('my_stylesheet')), sheet2 = YAHOO.util.StyleSheet('bob'); // sheetB is the same instance as sheet3 var sheet3 = YAHOO.util.StyleSheet('my sheet');

If an unregistered name is passed as the first argument to the constructor, a new empty StyleSheet will be created and registered with that name. This allows you to use the following code pattern:

// Whichever of these executes first, an empty StyleSheet will be created // and registered as 'MyApp'. // In one area of your app YAHOO.util.StyleSheet('MyApp').set('.module .messages', { display: 'none' }); ... // In another area of your app YAHOO.util.StyleSheet('MyApp').unset('.module .messages','display');

Summary of how the constructor handles the first argument

When nothing is passed as the first argument, a new StyleSheet instance is created.

When a <style> or <link> element is passed as the first argument, it is inspected for the id stamp that StyleSheet tags known host nodes with. If it finds one, it will return the associated StyleSheet from the registry. If not, it will stamp the node and seed the instance from the node's CSS content.

When a string is passed as the first argument, StyleSheet does the following things in order:

1. Check the registry for an instance associated to that name. If found, return the instance.
2. Check the DOM for a <style> or <link> node with that id. If found, check the registry for an instance associated to its tagged id if present. If found, return that instance. If not, use that node to seed a new StyleSheet instance.
3. Check the string for a curly brace { character. If found, create a new instance seeded with the string as initial cssText.
4. Create a new empty StyleSheet and register the instance by the provided string

Creating and modifying CSS style rules

The core method of StyleSheet instances is set(selector, style_properties). It will create or alter a CSS rule using the property:value pairs in style_property targeting the provided selector. Pass either a string of CSS text or an object of property:value pairs for style_properties. In essence, it looks very much like natural CSS syntax.

YAHOO.util.StyleSheet('MyApp').set(".nav li", "font-size: 150%;"); YAHOO.util.StyleSheet('MyApp').set( "q.uoted select.or[str=ing]", { fontSize : "150%", // note the camel casing background : "#030 url(/images/bg_image.png) scroll repeat-y top left", cssFloat : "left", opacity : 0.5 // this will be normalized for IE });

Note that if you use the string form of style_properties no opacity normalization will be applied. If you use the object form of style_properties, the properties must be in JavaScript's camelCase, but opacity will be normalized.

Rather than continually add new rules that will override one another, StyleSheet manages one rule per selector and modifies them in place. This may be relevant if you have two or more rules with selectors of the same specificity.

As with regular CSS syntax, comma separated selectors are supported, but internally StyleSheet splits them up into individual rules because browser support for multiple selectors is not consistent. This means calling set(..) with such a selector string will incur multiple repaints or reflows, but limited to the number of atomic selectors.

// This is valid, but will trigger 3 reflows YAHOO.util.StyleSheet('MyApp').set( '.foo, .bar, .baz', { borderRight: "1em solid #f00" });

Some style properties are normalized

Two style properties have differing implementation between browsers, namely float and opacity.

Because "float" is a reserved word in JavaScript, it is supported by the name cssFloat in W3C compliant browsers, and styleFloat in IE. StyleSheet will accept any of these to set the float property.

// Any of these will work for property:value object syntax YAHOO.util.StyleSheet('MyApp').set('.foo', { "float" : "left", // "float" must be quoted cssFloat : "right", styleFloat : "none" }); // Only this will work for CSS text syntax YAHOO.util.StyleSheet('MyApp').set(".foo","float: left;");

IE does not support the opacity style property, but has equivalent functionality offered by its proprietary filter property. StyleSheet will translate opacity to filter for IE if you use the property:value object syntax for set.

// This will set opacity for W3C browsers, and filter for IE YAHOO.util.StyleSheet('MyApp').set('.foo', { opacity: 0.5 }); // However, this will not be normalized YAHOO.util.StyleSheet('MyApp').set(".foo","opacity: 0.5;");

Removing and resetting CSS style rules

When you want to remove a particular rule or style property from effecting the cascade, use unset(selector,propert[y|ies]).

unset(..) can be called in any of the following ways, with the noted result:

• unset('.foo') - removes the rule associated to the selector entirely
• unset('.foo','font') - unsets the font property and any child properties (e.g. 'font-weight','font-variant','font-size','line-height', and 'font-family'). If there are no set properties left, the rule is removed.
• unset('.foo',['font','border',...]) - same as above, but the rule is modified only once with the final applicable cssText.

It is important to note that there is a difference between setting a style property to its default value and unsetting it. The former can be achieved by calling set(selector, { property: "auto" }) (or the respective default value for that property).

However, as the CSS is reapplied to the page, the "auto" value will override any value for that property that may have cascaded in from another rule. This is different than removing the property assignment entirely, as this allows cascading values through.

YAHOO.util.StyleSheet('MyApp').set('.foo', { background: 'auto' }); // is NOT the same as YAHOO.util.StyleSheet('MyApp').unset('.foo','background');

A note on selector strings

Though the StyleSheet Utility takes selector strings as input to its API, it does not leverage YAHOO.util.Selector. The Selector Utility supplements native CSS support for DOM access, but accomplishes this through efficient DOM traversal. Since the StyleSheet Utility uses the browser's built-in stylesheet and rule objects, it can not handle selectors that are not supported by the browser's native CSS parser.

// This will not cause a style change in IE 6, for example YAHOO.util.StyleSheet('MyApp').set('input[type=checkbox]:checked', { verticalAlign : 'super' });

Disabling and enabling a StyleSheet

Disabling a StyleSheet effectively turns it off; no CSS from that stylesheet is applied to the page. Disabling a StyleSheet does not remove the host node from the page, and style can be reapplied by enabling the StyleSheet again.

When StyleSheets are disabled, it is still possible to change their style rules via set and unset.

var sheet = YAHOO.util.StyleSheet(styleNode); sheet.disable(); sheet.set('.foo', { backgroundColor: '#900', color: '#fff' }); sheet.set('.bar', { borderBottomColor: '#369' }); sheet.unset('.baz'); sheet.enable();

Support for method chaining

All instance methods except getId and getCssText return the StyleSheet instance, allowing for method chaining. So the code snippet above could instead be written like this:

YAHOO.util.StyleSheet(styleNode). disable(). set('.foo', { backgroundColor: '#900', color: '#fff' }). set('.bar', { borderBottomColor: '#369' }). unset('.baz'). enable();

Static methods

YAHOO.util.StyleSheet exposes a few static methods.

YAHOO.util.StyleSheet.toCssText is used internally to assemble the cssText strings for updating the stylesheet rules. However, it may also be helpful for avoiding reflow overhead when substantially modifying a single element's style.

var el = YAHOO.util.Dom.get('some_element'), changes = { color : '#684', fontWeight: 'bold', padding: '2em' }, currentStyle = YAHOO.util.Dom.getStyle(el, 'cssText'); YAHOO.util.Dom.setStyle(el,'cssText', YAHOO.util.StyleSheet.toCssText(changes, currentStyle));

How YAHOO.util.StyleSheet works

Browsers grant access via the DOM API to stylesheets included in markup as <link> or <style> elements. Despite differing implementations across the browser spectrum, they all support adding, removing, and modifying CSS rules.

CSS rules are comprised of a selector and collection of style property:value pairs enclosed in curly braces.

/* | This is a CSS rule | | selectorText | style properties | */ div.this-is a .rule { font-color: #f00; }

In JavaScript, each rule object has a selectorText property and a style property that operates in the same way as the style property on regular DOM elements, such as <p> or <strong> elements.

Arguably the most valuable property of the style collection is cssText which corresponds to the serialized summary of property:value pairs applied by this collection (e.g. "font-size: 100%; color: #FF0000;"). The reason this property is important is that modifications to the string value will cause changes to repopulate the individual style properties while only triggering a single repaint or reflow by the browser.

var el = YAHOO.util.Dom.get('some_element'); el.style.borderBottom = '3px solid #eee'; // reflow el.style.borderTop = '3px solid #ccc'; // another reflow el.style.fontWeight = 'bold'; // another reflow // Vs. three changes in one reflow el.style.cssText += '; border-bottom: 3px solid #eee; border-top: 3px solid #ccc; font-weight: bold';

YAHOO.util.StyleSheet leverages this mechanism in addition to applying modifications at the CSS rule level rather than modifying each targeted DOM node directly. This means changing multiple style properties on multiple elements (that can be identified by a single selector) will only ever incur one repaint or reflow.

// If getElementsByClassName finds 10 nodes, the browser will trigger // 10 repaints and 20 reflows YAHOO.util.Dom.getElementsByClassName('change-me','*','root', function (el) { YAHOO.util.Dom.setStyle(el,'color','#f00'); YAHOO.util.Dom.setStyle(el,'fontWeight','bold'); YAHOO.util.Dom.setStyle(el,'borderBottom','3px solid #f00'); } ) // StyleSheet equivalent. This will trigger one reflow myStyleSheet.set('#root .change-me', { color : '#f00', fontWeight : 'bold', borderBottom : '3px solid #f00' });

YUI on Mobile: Using StyleSheet Utility with "A-Grade" Mobile Browsers

Support & Community

The YUI Library and related topics are discussed on the on the YUILibrary.com forums.

Also be sure to check out YUIBlog for updates and articles about the YUI Library written by the library's developers.

Filing Bugs & Feature Requests

The YUI Library's public bug tracking and feature request repositories are located on the YUILibrary.com site. Before filing new feature requests or bug reports, please review our reporting guidelines.