39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
webcomponents.js
|
|
================
|
|
|
|
A suite of polyfills supporting the HTML web components specs:
|
|
|
|
**Custom Elements**: allows authors to define their own custom tags ([spec](https://w3c.github.io/webcomponents/spec/custom/)).
|
|
|
|
**HTML Imports**: a way to include and reuse HTML documents via other HTML documents ([spec](https://w3c.github.io/webcomponents/spec/imports/)).
|
|
|
|
**Shadow DOM**: provides encapsulation by hiding DOM subtrees under shadow roots ([spec](https://w3c.github.io/webcomponents/spec/shadow/)).
|
|
|
|
This also folds in polyfills for `MutationObserver` and `WeakMap`.
|
|
|
|
|
|
## Releases
|
|
|
|
Pre-built (concatenated & minified) versions of the polyfills are maintained in the [tagged versions](https://github.com/Polymer/webcomponentsjs/releases) of this repo. There are two variants:
|
|
|
|
`webcomponents.js` includes all of the polyfills.
|
|
|
|
`webcomponents-lite.js` includes all polyfills except for shadow DOM.
|
|
|
|
|
|
### Manually Building
|
|
|
|
If you wish to build the polyfills yourself, you'll need `node` and `gulp` on your system:
|
|
|
|
* install [node.js](http://nodejs.org/) using the instructions on their website
|
|
* use `npm` to install [gulp.js](http://gulpjs.com/): `npm install -g gulp`
|
|
|
|
Now you are ready to build the polyfills with:
|
|
|
|
# install dependencies
|
|
npm install
|
|
# build
|
|
gulp build
|
|
|
|
The builds will be placed into the `dist/` directory.
|