Skip to content

Update README.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+21 −1
Open

Update README.md #15

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88fc676
Update README.md
AndyOGo Feb 27, 2019
e6821b2
feat: reword webcomponents polyfill caveat note
AndyOGo Feb 27, 2019
f4d72de
feat: reword to more diplomatic wording
AndyOGo Feb 28, 2019
80bf746
feat: reword fantastic to evergreen
AndyOGo Mar 4, 2019
f647490
feat: link built-in browser support separately
AndyOGo Mar 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,30 @@ or `super()` calls. There are a couple of ways to pull it off:
```

## Polyfills

Polyfilling custom elements and Web-Components in general is a very challanging task.
Depending at your use case one of the following polyfill will suit you best,
so please make sure to know their strong and weak parts.

**@webcomponents**

The semi-official [webcomponents/custom-elements] polyfill is what GitHub uses,
and it provides a bunch of workarounds for the spec rules involving class
constructors and the `new` keyword. You should use it, too!
constructors and the `new` keyword.
You need `ShadowDOM`? Works with [webcomponents/shadydom]

Be aware of:
- that extended built-in custom elements aren't supported,
- [known limitations](https://github.com/webcomponents/custom-elements#known-bugs-and-limitations)

**@WebReflection**

A stand-alone lightweight version of [Custom Elements V1](https://html.spec.whatwg.org/multipage/scripting.html#custom-elements)
based on top, and compatible with, the battle-tested [Custom Elements V0](http://w3c.github.io/webcomponents/spec/custom/),
already used in production with projects such as [Google AMP HTML ⚡](https://github.com/ampproject/amphtml#amp-html-) and others.
- [WebReflection/document-register-element] (supports V1 despites it's name) has [evergreen browser support](https://github.com/WebReflection/document-register-element#tested-on) and a [public test page](http://webreflection.github.io/document-register-element/test/), please note the [`constructor` caveat](https://github.com/WebReflection/document-register-element#v1-caveat).
- [built-in-element](https://github.com/ungap/custom-elements-builtin) again [evergreen browser support](https://github.com/ungap/custom-elements-builtin#compatible-with-) and [live test page](https://ungap.github.io/custom-elements-builtin/test/es5/), please note the [`constructor` caveat](https://github.com/ungap/custom-elements-builtin#constructor-caveat).
- You need `ShadowDOM`? Works with [WebReflection/attachshadow](https://github.com/WebReflection/attachshadow)

## Further reading
* [Custom Elements v1: Reusable Web Components (Google)](https://developers.google.com/web/fundamentals/web-components/customelements) is a great introduction to custom elements.
Expand Down