OLD | NEW |
(Empty) | |
| 1 webcomponents.js |
| 2 ================ |
| 3 |
| 4 A suite of polyfills supporting the [Web Components](http://webcomponents.org) s
pecs: |
| 5 |
| 6 **Custom Elements**: allows authors to define their own custom tags ([spec](http
s://w3c.github.io/webcomponents/spec/custom/)). |
| 7 |
| 8 **HTML Imports**: a way to include and reuse HTML documents via other HTML docum
ents ([spec](https://w3c.github.io/webcomponents/spec/imports/)). |
| 9 |
| 10 **Shadow DOM**: provides encapsulation by hiding DOM subtrees under shadow roots
([spec](https://w3c.github.io/webcomponents/spec/shadow/)). |
| 11 |
| 12 This also folds in polyfills for `MutationObserver` and `WeakMap`. |
| 13 |
| 14 |
| 15 ## Releases |
| 16 |
| 17 Pre-built (concatenated & minified) versions of the polyfills are maintained in
the [tagged versions](https://github.com/webcomponents/webcomponentsjs/releases)
of this repo. There are two variants: |
| 18 |
| 19 `webcomponents.js` includes all of the polyfills. |
| 20 |
| 21 `webcomponents-lite.js` includes all polyfills except for shadow DOM. |
| 22 |
| 23 |
| 24 ### Manually Building |
| 25 |
| 26 If you wish to build the polyfills yourself, you'll need `node` and `gulp` on yo
ur system: |
| 27 |
| 28 * install [node.js](http://nodejs.org/) using the instructions on their website |
| 29 * use `npm` to install [gulp.js](http://gulpjs.com/): `npm install -g gulp` |
| 30 |
| 31 Now you are ready to build the polyfills with: |
| 32 |
| 33 # install dependencies |
| 34 npm install |
| 35 # build |
| 36 gulp build |
| 37 |
| 38 The builds will be placed into the `dist/` directory. |
| 39 |
| 40 ## Contribute |
| 41 |
| 42 See the [contributing guide](CONTRIBUTING.md) |
| 43 |
| 44 |
OLD | NEW |