shadow_dom 0.9.2

Shadow DOM polyfill

Shadow DOM is designed to provide encapsulation by hiding DOM subtrees under shadow roots. It provides a method of establishing and maintaining functional boundaries between DOM trees and how these trees interact with each other within a document, thus enabling better functional encapsulation within the DOM. See the W3C specification for details.

Getting started

Include the polyfill in your HTML <head> to enable Shadow DOM:

    <script src="packages/shadow_dom/shadow_dom.debug.js"></script>

You can also use a minified version for deployment:

    <script src="packages/shadow_dom/shadow_dom.min.js"></script>

Because it does extensive DOM patching, it should be included before other script tags.

Useful resources

Learn the tech

Basic usage

var el = new DivElement();
var shadow = el.createShadowRoot();
shadow.innerHtml = '<content select="h1"></content>';

Shadow DOM subtrees

Shadow DOM allows a single node to express three subtrees: light DOM, shadow DOM, and composed DOM.

A component user supplies the light DOM; the node has a (hidden) shadow DOM; and the composed DOM is what is actually rendered in the browser. At render time, the light DOM is merged with the shadow DOM to produce the composed DOM. For example:

Light DOM

<my-custom-element>
  <!-- everything in here is my-custom-element's light DOM -->
  <q>Hello World</q>
</my-custom-element>

Shadow DOM

<!-- shadow-root is attached to my-custom-element, but is not a child -->
<shadow-root>
  <!-- everything in here is my-custom-element's shadow DOM -->
  <span>People say: <content></content></span>
</shadow-root>

Composed (rendered) DOM

<!-- rendered DOM -->
<my-custom-element>
  <span>People say: <q>Hello World</q></span>
</my-custom-element>

The following is true about this example:

  • The light DOM that belongs to <my-custom-element> is visible to the user as its normal subtree. It can expressed by .childNodes, .nodes, .innerHtml or any other property or method that gives you information about a node's subtree.
  • Nodes in light DOM or shadow DOM express parent and sibling relationships that match their respective tree structures; the relationships that exist in the rendered tree are not expressed anywhere in DOM.

So, while in the final rendered tree <span> is a child of <my-custom-element> and the parent of <q>, interrogating those nodes will tell you that the <span> is a child of <shadow-root> and <q> is a child of <my-custom-element>, and that those two nodes are unrelated.

In this way, the user can manipulate light DOM or shadow DOM directly as regular DOM subtrees, and let the system take care of keeping the render tree synchronized.

Polyfill details

You can read more about how the polyfill is implemented in JavaScript here: https://github.com/polymer/ShadowDOM#polyfill-details.

Getting the source code

This package is built from: https://github.com/dart-lang/ShadowDOM/tree/conditional_shadowdom

You'll need node.js to rebuild the JS file. Use npm install to get dependencies and grunt to build.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  shadow_dom: ">=0.9.2 <0.10.0"

If your package is an application package you should use any as the version constraint.

2. Install it

If you're using the Dart Editor, choose:

Menu > Tools > Pub Install

Or if you want to install from the command line, run:

$ pub install

About

Shadow DOM is designed to provide encapsulation by hiding DOM subtrees under shadow roots. It provides a method of establishing and maintaining functional boundaries between DOM trees and how these trees interact with each other within a document, thus enabling better functional encapsulation within the DOM.

Author

Email web-ui-dev@dartlang.org Polymer.dart Authors

Homepage

https://www.dartlang.org/polymer-dart/

Uploader

jmesserly@google.com
dgrove@google.com
sigmund@google.com

Share