Skip to content

brigand/scoped-polyfill

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scoped polyfill for HTML5 <style scoped> elements

This code changes the actual <style> node in the DOM instead of computing the styles certain nodes might get and applying them on them inline. This is usefull when adding new nodes to a container that is "scoped".

It does so by prepending the styleRules selectorText with id's to syntheticaly up the styleRules' specificity and thus overriding (if defined in the scoped <style> node) the styles which are inherited from the main HTML.

Tested (and working) on:

  • IE 6, 7, 8, 9 (Yes also in all the FrankensteinModes™)
  • Firefox latest Mac/Windows/Linux(Ubuntu)
  • Google Chrome latest Mac/Windows/Linux(Ubuntu)
  • Opera latest Mac/Windows
  • Safari latest Mac/Windows

Usage:

  • Just include scoped.js

This will polyfill all existing <style scoped> nodes in the DOM at that point. If new ones are added later, you can call the function returned by the constructor to convert the new one as well: scopedPolyFill();

The position of scoped.js should be after all the <style scoped> nodes in the document. If you want to initialize it yourself the position doesn't matter.

If you're a jQuery user you can also pass in a jQuery object with <style scoped> nodes and it will polyfill them all.

Features:

  • Tests if scoped is supported and if it is it does nothing.
  • If scoped is not supported by the browser visiting that page, an empty <style> element is made and appended to the body.
    • This is because some browsers don't have a sheet property until appended to the DOM.
  • Then it sorts out the different names browsers use to get to the same properties (like rule/cssRule and sheet/getSheet/styleSheet) and returns them into the closurre to only have to check those things once, after that you can just use the compat[ name ] to access it.
  • It also checks if the renaming of selectortext is prohibited or not because when changing the <style> its easier to just edit the selectorText instead of copying the rule, changing it and appending it to the <style> and removing the old one.

Notes:

This does not completely sandbox the CSS for the HTML inside the <style scoped>'s parentNode, it is meant to work the way scoped is going to work.

This way you can inherit styles and override the ones you want to override without leaking those styles to the whole DOM.
@import and other non-normal style rules are not changed so do not use them in the inline <style>, IE does not expose them via the DOM so to prevent incompatilbilities they are not touched by this code.

It is possible (though the chance is very small) that an inherited styleRule's CSS selector after polyfilling still is more specific than the scoped styleRule's selector. In that case please just up the specificity of the scoped styleRule's selector and not use !important since this make using user stylesheets a lot more diffucult (for instance for visually impared people who want to override background-color, font-size and color)

Misc

If you would like to keep your Global scope as clean as possible:

Delete the first 20 characters of scoped.js; these: var scopedPolyFill =

This also removes your ability to call the function at runtime, e.g. via jQuery, since that method needs a globally scoped reference. I can wrap it as a jQuery plugin when there's a need, but I like the fact that it works with the same code in and out of jQuery now.

About

Vanilla JavaScript polyfill for scoped style in HTML5, also works with jQuery if you want to.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.1%
  • CSS 4.9%