2 Copyright (c) 2009, Yahoo! Inc. All rights reserved.
3 Code licensed under the BSD License:
4 http://developer.yahoo.net/yui/license.txt
8 * The StyleSheet component is a utility for managing css rules at the
12 * @namespace YAHOO.util
19 p = d.createElement('p'), // Have to hold the node (see notes)
20 workerStyle = p.style, // worker style collection
25 floatAttr = ('cssFloat' in workerStyle) ? 'cssFloat' : 'styleFloat',
31 * Normalizes the removal of an assigned style for opacity. IE uses the filter property.
33 _unsetOpacity = ('opacity' in workerStyle) ?
34 function (style) { style.opacity = ''; } :
35 function (style) { style.filter = ''; };
38 * Normalizes the removal of an assigned style for a given property. Expands
39 * shortcut properties if necessary and handles the various names for the float property.
41 workerStyle.border = "1px solid red";
42 workerStyle.border = ''; // IE doesn't unset child properties
43 _unsetProperty = workerStyle.borderLeft ?
44 function (style,prop) {
46 if (prop !== floatAttr && prop.toLowerCase().indexOf('float') != -1) {
49 if (typeof style[prop] === 'string') {
52 case 'filter' : _unsetOpacity(style); break;
54 style.font = style.fontStyle = style.fontVariant =
55 style.fontWeight = style.fontSize = style.lineHeight =
56 style.fontFamily = '';
60 if (p.indexOf(prop) === 0) {
67 function (style,prop) {
68 if (prop !== floatAttr && prop.toLowerCase().indexOf('float') != -1) {
71 if (lang.isString(style[prop])) {
72 if (prop === 'opacity') {
81 * Create an instance of YAHOO.util.StyleSheet to encapsulate a css stylesheet.
82 * The constructor can be called using function or constructor syntax.
83 * <pre><code>var sheet = YAHOO.util.StyleSheet(..);</pre></code>
85 * <pre><code>var sheet = new YAHOO.util.StyleSheet(..);</pre></code>
87 * The first parameter passed can be any of the following things:
89 * <li>The desired string name to register a new empty sheet</li>
90 * <li>The string name of an existing YAHOO.util.StyleSheet instance</li>
91 * <li>The unique yuiSSID generated for an existing YAHOO.util.StyleSheet instance</li>
92 * <li>The id of an existing <code><link></code> or <code><style></code> node</li>
93 * <li>The node reference for an existing <code><link></code> or <code><style></code> node</li>
94 * <li>A chunk of css text to create a new stylesheet from</li>
97 * <p>If a string is passed, StyleSheet will first look in its static name
98 * registry for an existing sheet, then in the DOM for an element with that id.
99 * If neither are found and the string contains the { character, it will be
100 * used as a the initial cssText for a new StyleSheet. Otherwise, a new empty
101 * StyleSheet is created, assigned the string value as a name, and registered
102 * statically by that name.</p>
104 * <p>The optional second parameter is a string name to register the sheet as.
105 * This param is largely useful when providing a node id/ref or chunk of css
106 * text to create a populated instance.</p>
110 * @param seed {String|HTMLElement} a style or link node, its id, or a name or
111 * yuiSSID of a StyleSheet, or a string of css text (see above)
112 * @param name {String} OPTIONAL name to register instance for future static
115 function StyleSheet(seed, name) {
125 // Factory or constructor
126 if (!(this instanceof StyleSheet)) {
127 return new StyleSheet(seed,name);
130 // capture the DOM node if the string is an id
131 node = seed && (seed.nodeName ? seed : d.getElementById(seed));
133 // Check for the StyleSheet in the static registry
134 if (seed && sheets[seed]) {
136 } else if (node && node.yuiSSID && sheets[node.yuiSSID]) {
137 return sheets[node.yuiSSID];
140 // Create a style node if necessary
141 if (!node || !/^(?:style|link)$/i.test(node.nodeName)) {
142 node = d.createElement('style');
143 node.type = 'text/css';
146 if (lang.isString(seed)) {
147 // Create entire sheet from seed cssText
148 if (seed.indexOf('{') != -1) {
149 // Not a load-time fork because low run-time impact and IE fails
150 // test for s.styleSheet at page load time (oddly)
151 if (node.styleSheet) {
152 node.styleSheet.cssText = seed;
154 node.appendChild(d.createTextNode(seed));
161 if (!node.parentNode || node.parentNode.nodeName.toLowerCase() !== 'head') {
162 head = (node.ownerDocument || d).getElementsByTagName('head')[0];
163 // styleSheet isn't available on the style node in FF2 until appended
164 // to the head element. style nodes appended to body do not affect
166 head.appendChild(node);
169 // Begin setting up private aliases to the important moving parts
170 // 1. The stylesheet object
171 // IE stores StyleSheet under the "styleSheet" property
172 // Safari doesn't populate sheet for xdomain link elements
173 sheet = node.sheet || node.styleSheet;
175 // 2. The style rules collection
176 // IE stores the rules collection under the "rules" property
177 _rules = sheet && ('cssRules' in sheet) ? 'cssRules' : 'rules';
179 // 3. The method to remove a rule from the stylesheet
180 // IE supports removeRule
181 _deleteRule = ('deleteRule' in sheet) ?
182 function (i) { sheet.deleteRule(i); } :
183 function (i) { sheet.removeRule(i); };
185 // 4. The method to add a new rule to the stylesheet
186 // IE supports addRule with different signature
187 _insertRule = ('insertRule' in sheet) ?
188 function (sel,css,i) { sheet.insertRule(sel+' {'+css+'}',i); } :
189 function (sel,css,i) { sheet.addRule(sel,css,i); };
191 // 5. Initialize the cssRules map from the node
192 // xdomain link nodes forbid access to the cssRules collection, so this
193 // will throw an error.
194 // TODO: research alternate stylesheet, @media
195 for (i = sheet[_rules].length - 1; i >= 0; --i) {
196 r = sheet[_rules][i];
197 sel = r.selectorText;
200 cssRules[sel].style.cssText += ';' + r.style.cssText;
207 // Cache the instance by the generated Id
208 node.yuiSSID = 'yui-stylesheet-' + (ssId++);
209 StyleSheet.register(node.yuiSSID,this);
211 // Register the instance by name if provided or defaulted from seed
213 StyleSheet.register(name,this);
217 lang.augmentObject(this,{
219 * Get the unique yuiSSID for this StyleSheet instance
222 * @return {Number} the static id
224 getId : function () { return node.yuiSSID; },
227 * The HTMLElement that this instance encapsulates
235 * Enable all the rules in the sheet
238 * @return {StyleSheet} the instance
241 // Enabling/disabling the stylesheet. Changes may be made to rules
243 enable : function () { sheet.disabled = false; return this; },
246 * Disable all the rules in the sheet. Rules may be changed while the
247 * StyleSheet is disabled.
250 * @return {StyleSheet} the instance
253 disable : function () { sheet.disabled = true; return this; },
256 * Returns boolean indicating whether the StyleSheet is enabled
259 * @return {Boolean} is it enabled?
261 isEnabled : function () { return !sheet.disabled; },
264 * <p>Set style properties for a provided selector string.
265 * If the selector includes commas, it will be split into individual
266 * selectors and applied accordingly. If the selector string does not
267 * have a corresponding rule in the sheet, it will be added.</p>
269 * <p>The second parameter can be either a string of CSS text,
270 * formatted as CSS ("font-size: 10px;"), or an object collection of
271 * properties and their new values. Object properties must be in
272 * JavaScript format ({ fontSize: "10px" }).</p>
274 * <p>The float style property will be set by any of "float",
275 * "styleFloat", or "cssFloat" if passed in the
276 * object map. Use "float: left;" format when passing a CSS text
280 * @param sel {String} the selector string to apply the changes to
281 * @param css {Object|String} Object literal of style properties and
282 * new values, or a string of cssText
283 * @return {StyleSheet} the StyleSheet instance
286 set : function (sel,css) {
287 var rule = cssRules[sel],
288 multi = sel.split(/\s*,\s*/),i,
291 // IE's addRule doesn't support multiple comma delimited selectors
292 if (multi.length > 1) {
293 for (i = multi.length - 1; i >= 0; --i) {
294 this.set(multi[i], css);
299 // Some selector values can cause IE to hang
300 if (!StyleSheet.isValidSelector(sel)) {
304 // Opera throws an error if there's a syntax error in assigned
305 // cssText. Avoid this using a worker style collection, then
306 // assigning the resulting cssText.
308 rule.style.cssText = StyleSheet.toCssText(css,rule.style.cssText);
310 idx = sheet[_rules].length;
311 css = StyleSheet.toCssText(css);
313 // IE throws an error when attempting to addRule(sel,'',n)
314 // which would crop up if no, or only invalid values are used
316 _insertRule(sel, css, idx);
318 // Safari replaces the rules collection, but maintains the
319 // rule instances in the new collection when rules are
321 cssRules[sel] = sheet[_rules][idx];
328 * <p>Unset style properties for a provided selector string, removing
329 * their effect from the style cascade.</p>
331 * <p>If the selector includes commas, it will be split into individual
332 * selectors and applied accordingly. If there are no properties
333 * remaining in the rule after unsetting, the rule is removed.</p>
335 * <p>The style property or properties in the second parameter must be the
336 * <p>JavaScript style property names. E.g. fontSize rather than font-size.</p>
338 * <p>The float style property will be unset by any of "float",
339 * "styleFloat", or "cssFloat".</p>
342 * @param sel {String} the selector string to apply the changes to
343 * @param css {String|Array} style property name or Array of names
344 * @return {StyleSheet} the StyleSheet instance
347 unset : function (sel,css) {
348 var rule = cssRules[sel],
349 multi = sel.split(/\s*,\s*/),
353 // IE's addRule doesn't support multiple comma delimited selectors
354 // so rules are mapped internally by atomic selectors
355 if (multi.length > 1) {
356 for (i = multi.length - 1; i >= 0; --i) {
357 this.unset(multi[i], css);
364 if (!lang.isArray(css)) {
368 workerStyle.cssText = rule.style.cssText;
369 for (i = css.length - 1; i >= 0; --i) {
370 _unsetProperty(workerStyle,css[i]);
373 if (workerStyle.cssText) {
374 rule.style.cssText = workerStyle.cssText;
380 if (remove) { // remove the rule altogether
381 rules = sheet[_rules];
382 for (i = rules.length - 1; i >= 0; --i) {
383 if (rules[i] === rule) {
384 delete cssRules[sel];
395 * Get the current cssText for a rule or the entire sheet. If the
396 * selector param is supplied, only the cssText for that rule will be
397 * returned, if found. If the selector string targets multiple
398 * selectors separated by commas, the cssText of the first rule only
399 * will be returned. If no selector string, the stylesheet's full
400 * cssText will be returned.
403 * @param sel {String} Selector string
406 getCssText : function (sel) {
409 if (lang.isString(sel)) {
410 // IE's addRule doesn't support multiple comma delimited
411 // selectors so rules are mapped internally by atomic selectors
412 rule = cssRules[sel.split(/\s*,\s*/)[0]];
414 return rule ? rule.style.cssText : null;
417 for (sel in cssRules) {
418 if (cssRules.hasOwnProperty(sel)) {
419 rule = cssRules[sel];
420 css.push(rule.selectorText+" {"+rule.style.cssText+"}");
423 return css.join("\n");
430 _toCssText = function (css,base) {
431 var f = css.styleFloat || css.cssFloat || css['float'],
434 workerStyle.cssText = base || '';
436 if (lang.isString(css)) {
437 // There is a danger here of incremental memory consumption in Opera
438 workerStyle.cssText += ';' + css;
440 if (f && !css[floatAttr]) {
441 css = lang.merge(css);
442 delete css.styleFloat; delete css.cssFloat; delete css['float'];
447 if (css.hasOwnProperty(prop)) {
449 // IE throws Invalid Value errors and doesn't like whitespace
450 // in values ala ' red' or 'red '
451 workerStyle[prop] = lang.trim(css[prop]);
459 return workerStyle.cssText;
462 lang.augmentObject(StyleSheet, {
464 * <p>Converts an object literal of style properties and values into a string
465 * of css text. This can then be assigned to el.style.cssText.</p>
467 * <p>The optional second parameter is a cssText string representing the
468 * starting state of the style prior to alterations. This is most often
469 * extracted from the eventual target's current el.style.cssText.</p>
471 * @method StyleSheet.toCssText
472 * @param css {Object} object literal of style properties and values
473 * @param cssText {String} OPTIONAL starting cssText value
474 * @return {String} the resulting cssText string
477 toCssText : (('opacity' in workerStyle) ? _toCssText :
478 // Wrap IE's toCssText to catch opacity. The copy/merge is to preserve
479 // the input object's integrity, but if float and opacity are set, the
480 // input will be copied twice in IE. Is there a way to avoid this
481 // without increasing the byte count?
482 function (css, cssText) {
483 if (lang.isObject(css) && 'opacity' in css) {
484 css = lang.merge(css,{
485 filter: 'alpha(opacity='+(css.opacity*100)+')'
489 return _toCssText(css,cssText);
493 * Registers a StyleSheet instance in the static registry by the given name
495 * @method StyleSheet.register
496 * @param name {String} the name to assign the StyleSheet in the registry
497 * @param sheet {StyleSheet} The StyleSheet instance
498 * @return {Boolean} false if no name or sheet is not a StyleSheet
499 * instance. true otherwise.
502 register : function (name,sheet) {
503 return !!(name && sheet instanceof StyleSheet &&
504 !sheets[name] && (sheets[name] = sheet));
508 * <p>Determines if a selector string is safe to use. Used internally
509 * in set to prevent IE from locking up when attempting to add a rule for a
510 * "bad selector".</p>
512 * <p>Bad selectors are considered to be any string containing unescaped
513 * `~!@$%^&()+=|{}[];'"?< or space. Also forbidden are . or # followed by
514 * anything other than an alphanumeric. Additionally -abc or .-abc or
515 * #_abc or '# ' all fail. There are likely more failure cases, so
516 * please file a bug if you encounter one.</p>
518 * @method StyleSheet.isValidSelector
519 * @param sel {String} the selector string
523 isValidSelector : function (sel) {
526 if (sel && lang.isString(sel)) {
528 if (!selectors.hasOwnProperty(sel)) {
529 // TEST: there should be nothing but white-space left after
530 // these destructive regexs
531 selectors[sel] = !/\S/.test(
533 sel.replace(/\s+|\s*[+~>]\s*/g,' ').
534 // attribute selectors (contents not validated)
535 replace(/([^ ])\[.*?\]/g,'$1').
536 // pseudo-class|element selectors (contents of parens
537 // such as :nth-of-type(2) or :not(...) not validated)
538 replace(/([^ ])::?[a-z][a-z\-]+[a-z](?:\(.*?\))?/ig,'$1').
540 replace(/(?:^| )[a-z0-6]+/ig,' ').
541 // escaped characters
543 // class and id identifiers
544 replace(/[.#]\w[\w\-]*/g,''));
547 valid = selectors[sel];
554 YAHOO.util.StyleSheet = StyleSheet;
561 * Style node must be added to the head element. Safari does not honor styles
562 applied to StyleSheet objects on style nodes in the body.
563 * StyleSheet object is created on the style node when the style node is added
564 to the head element in Firefox 2 (and maybe 3?)
565 * The cssRules collection is replaced after insertRule/deleteRule calls in
566 Safari 3.1. Existing Rules are used in the new collection, so the collection
567 cannot be cached, but the rules can be.
568 * Opera requires that the index be passed with insertRule.
569 * Same-domain restrictions prevent modifying StyleSheet objects attached to
570 link elements with remote href (or "about:blank" or "javascript:false")
571 * Same-domain restrictions prevent reading StyleSheet cssRules/rules
572 collection of link elements with remote href (or "about:blank" or
574 * Same-domain restrictions result in Safari not populating node.sheet property
575 for link elements with remote href (et.al)
576 * IE names StyleSheet related properties and methods differently (see code)
577 * IE converts tag names to upper case in the Rule's selectorText
578 * IE converts empty string assignment to complex properties to value settings
579 for all child properties. E.g. style.background = '' sets non-'' values on
580 style.backgroundPosition, style.backgroundColor, etc. All else clear
581 style.background and all child properties.
582 * IE assignment style.filter = '' will result in style.cssText == 'FILTER:'
583 * All browsers support Rule.style.cssText as a read/write property, leaving
584 only opacity needing to be accounted for.
585 * Benchmarks of style.property = value vs style.cssText += 'property: value'
586 indicate cssText is slightly slower for single property assignment. For
587 multiple property assignment, cssText speed stays relatively the same where
588 style.property speed decreases linearly by the number of properties set.
589 Exception being Opera 9.27, where style.property is always faster than
591 * Opera 9.5b throws a syntax error when assigning cssText with a syntax error.
592 * Opera 9.5 doesn't honor rule.style.cssText = ''. Previous style persists.
593 You have to remove the rule altogether.
594 * Stylesheet properties set with !important will trump inline style set on an
595 element or in el.style.property.
596 * Creating a worker style collection like document.createElement('p').style;
597 will fail after a time in FF (~5secs of inactivity). Property assignments
598 will not alter the property or cssText. It may be the generated node is
599 garbage collected and the style collection becomes inert (speculation).
600 * IE locks up when attempting to add a rule with a selector including at least
601 characters {[]}~`!@%^&*()+=|? (unescaped) and leading _ or -
602 such as addRule('-foo','{ color: red }') or addRule('._abc','{...}')
603 * IE's addRule doesn't support comma separated selectors such as
604 addRule('.foo, .bar','{..}')
605 * IE throws an error on valid values with leading/trailing white space.
606 * When creating an entire sheet at once, only FF2/3 & Opera allow creating a
607 style node, setting its innerHTML and appending to head.
608 * When creating an entire sheet at once, Safari requires the style node to be
609 created with content in innerHTML of another element.
610 * When creating an entire sheet at once, IE requires the style node content to
611 be set via node.styleSheet.cssText
612 * When creating an entire sheet at once in IE, styleSheet.cssText can't be
613 written until node.type = 'text/css'; is performed.
614 * When creating an entire sheet at once in IE, load-time fork on
615 var styleNode = d.createElement('style'); _method = styleNode.styleSheet ?..
616 fails (falsey). During run-time, the test for .styleSheet works fine
617 * Setting complex properties in cssText will SOMETIMES allow child properties
619 set unset FF2 FF3 S3.1 IE6 IE7 Op9.27 Op9.5
620 ---------- ----------------- --- --- ---- --- --- ------ -----
621 border -top NO NO YES YES YES YES YES
622 -top-color NO NO YES YES YES
623 -color NO NO NO NO NO
624 background -color NO NO YES YES YES
625 -position NO NO YES YES YES
626 -position-x NO NO NO NO NO
627 font line-height YES YES NO NO NO NO YES
628 -style YES YES NO YES YES
629 -size YES YES NO YES YES
630 -size-adjust ??? ??? n/a n/a n/a ??? ???
631 padding -top NO NO YES YES YES
632 margin -top NO NO YES YES YES
633 list-style -type YES YES YES YES YES
634 -position YES YES YES YES YES
635 overflow -x NO NO YES n/a YES
637 ??? - unsetting font-size-adjust has the same effect as unsetting font-size
638 * FireFox and WebKit populate rule.cssText as "SELECTOR { CSSTEXT }", but
640 * IE6 and IE7 silently ignore the { and } if passed into addRule('.foo','{
641 color:#000}',0). IE8 does not and creates an empty rule.
642 * IE6-8 addRule('.foo','',n) throws an error. Must supply *some* cssText
645 YAHOO.register("stylesheet", YAHOO.util.StyleSheet, {version: "2.8.0r4", build: "2449"});