Skip to content
This repository was archived by the owner on Sep 20, 2019. It is now read-only.

Commit 7a4760a

Browse files
committed
clean up README a little
1 parent 6559688 commit 7a4760a

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed

README.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,44 @@ webcomponents.js
33

44
[![Build Status](https://travis-ci.org/webcomponents/webcomponentsjs.svg?branch=master)](https://travis-ci.org/webcomponents/webcomponentsjs)
55

6-
A suite of polyfills supporting the [Web Components](http://webcomponents.org) specs:
6+
A suite of polyfills supporting the [Web Components](http://webcomponents.org) specs.
77

8-
**Custom Elements**: allows authors to define their own custom tags ([spec](https://w3c.github.io/webcomponents/spec/custom/)).
9-
10-
**HTML Imports**: a way to include and reuse HTML documents via other HTML documents ([spec](https://w3c.github.io/webcomponents/spec/imports/)).
11-
12-
**Shadow DOM**: provides encapsulation by hiding DOM subtrees under shadow roots ([spec](https://w3c.github.io/webcomponents/spec/shadow/)).
8+
- **Custom Elements**: allows authors to define their own custom tags ([spec](https://w3c.github.io/webcomponents/spec/custom/)).
9+
- **HTML Imports**: a way to include and reuse HTML documents via other HTML documents ([spec](https://w3c.github.io/webcomponents/spec/imports/)).
10+
- **Shadow DOM**: provides encapsulation by hiding DOM subtrees under shadow roots ([spec](https://w3c.github.io/webcomponents/spec/shadow/)).
1311

1412
## Releases
1513

16-
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:
17-
18-
`webcomponents.js` includes all of the polyfills.
19-
20-
`webcomponents-lite.js` includes all polyfills except for shadow DOM.
14+
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 several variants:
2115

16+
- `webcomponents-lite.js` includes all of the polyfills.
17+
- `webcomponents-loader.js` is a custom loader that dynamically load a minified polyfill
18+
bundle, using feature detection. The bundles that can be loaded are:
19+
- `webcomponents-hi` -- HTML Imports (needed by Safari Tech Preview)
20+
- `webcomponents-hi-ce` -- HTML Imports and Custom Elements (needed by Safari 10)
21+
- `webcomponents-hi-ce-sd` -- HTML Imports, Custom Elements and Shady DOM/CSS (needed by Safari 9, Firefox, Edge)
22+
- `webcomponents-lite` -- HTML Imports, Custom Elements, Shady DOM/CSS and generic platform polyfills (such as URL, Template, ES6 Promise, Constructable events, etc.) (needed by Internet Explorer 11)
2223

2324
## Browser Support
2425

2526
Our polyfills are intended to work in the latest versions of evergreen browsers. See below
2627
for our complete browser support matrix:
2728

28-
| Polyfill | IE10 | IE11+ | Chrome* | Firefox* | Safari 7+* | Chrome Android* | Mobile Safari* |
29-
| ---------- |:----:|:-----:|:-------:|:--------:|:----------:|:---------------:|:--------------:|
30-
| Custom Elements | ~ |||||||
31-
| HTML Imports | ~ |||||||
32-
| Shadow DOM ||||||||
33-
| Templates ||||||||
34-
35-
36-
*Indicates the current version of the browser
29+
| Polyfill | IE11+ | Chrome* | Firefox* | Safari 9+* | Chrome Android* | Mobile Safari* |
30+
| ---------- |:-----:|:-------:|:--------:|:----------:|:---------------:|:--------------:|
31+
| Custom Elements |||||||
32+
| HTML Imports |||||||
33+
| Shady CSS/DOM |||||||
3734

38-
~Indicates support may be flaky. If using Custom Elements or HTML Imports with Shadow DOM,
39-
you will get the non-flaky Mutation Observer polyfill that Shadow DOM includes.
35+
\*Indicates the current version of the browser
4036

4137
The polyfills may work in older browsers, however require additional polyfills (such as classList)
4238
to be used. We cannot guarantee support for browsers outside of our compatibility matrix.
4339

4440

4541
### Manually Building
4642

47-
If you wish to build the polyfills yourself, you'll need `node` and `gulp` on your system:
43+
If you wish to build the polyfills yourself, you'll need `node` and `npm` on your system:
4844

4945
* install [node.js](http://nodejs.org/) using the instructions on their website
5046
* use `npm` to install [gulp.js](http://gulpjs.com/): `npm install -g gulp`
@@ -53,10 +49,11 @@ Now you are ready to build the polyfills with:
5349

5450
# install dependencies
5551
npm install
52+
bower install
5653
# build
5754
gulp build
5855

59-
The builds will be placed into the `dist/` directory.
56+
The builds will be placed into the root directory.
6057

6158
## Contribute
6259

@@ -74,7 +71,7 @@ Copyright (c) 2015 The Polymer Authors. All rights reserved.
7471

7572
Under native HTML Imports, `<script>` tags in the main document block the loading of such imports. This is to ensure the imports have loaded and any registered elements in them have been upgraded.
7673

77-
The webcomponents.js and webcomponents-lite.js polyfills parse element definitions and handle their upgrade asynchronously. If prematurely fetching the element from the DOM before it has an opportunity to upgrade, you'll be working with an `HTMLUnknownElement`.
74+
The `webcomponents-lite.js` polyfill parse element definitions and handle their upgrade asynchronously. If prematurely fetching the element from the DOM before it has an opportunity to upgrade, you'll be working with an `HTMLUnknownElement`.
7875

7976
For these situations (or when you need an approximate replacement for the Polymer 0.5 `polymer-ready` behavior), you can use the `WebComponentsReady` event as a signal before interacting with the element. The criteria for this event to fire is all Custom Elements with definitions registered by the time HTML Imports available at load time have loaded have upgraded.
8077

0 commit comments

Comments
 (0)