stencil VS webcomponents

Web component browser APIs aren't that many, and not that hard to grasp (if you don't know about them, have a look at Google's Learn HTML section and MDN's Web Components guide); but creating a web component actually requires taking care of many small things. This is where web component libraries come in very handy, freeing us of having to think about some of those things by taking care of them for us. Most of the things I'll mention here are handled one way of another by other libraries (GitHub's Catalyst, Haunted, Hybrids, Salesforce's LWC, Slim.JS, Ionic's Stencil) but I'll focus on Google's Lit and Microsoft's FAST here as they probably are the most used web component libraries out there (ok, I lied, Lit definitely is, FAST not that much, far behind Lit and Stencil; but Lit and FAST have many things in common, starting with the fact that they are just native web components, contrary to Stencil that compiles to a web component). Both Lit and FAST leverage TypeScript decorators to simplify the code even further so I'll use that in examples, even though they can also be used in pure JS (decorators are coming to JS soon BTW). I'll also leave the most apparent yet most complex aspect for the end.

Look into https://stenciljs.com/ .

We used https://stenciljs.com/ for web components to be consumed by angular, AEM and react at a previous employer. It uses tsx/jsx. Components are easy to write and it has good documentation.

For the creation of web components, even though writing in vanilla js is an option, we have chosen to do it via a dedicated framework, which will solve many potential integration/bundling problems. The choice of the framework will be made according to different factors that are not part of the scope of this article.

Maybe have a look at Stencil (+ Ionic). https://stenciljs.com/

Pro:

- Simple to learn

- Doesn't change all the time

- First-class TypeScript support

- Good default UI via Ionic

- Compiles to Web Components (although to be honest, this doesn't really matter)

- Easy testing

- Ionic as a company invests in Ionic the framework + Stencil the compiler. Might be around in 10 years, altough things could change. But this is true for all frameworks.

- You basically get an iOS/Android app for free, if you just dump the output in Capacitor (also developed by Ionic the company).

Cons:

- Stencil is not very widespread as a frontend framework.

because react-native is only reactlike. I may or may not want to stick with that. I think something like this is leading us towards a better and less UI lib specific approach. https://github.com/ionic-team/stencil/ . I don't think is 100% where we end up, but it is based on web components, so it's moving the entire ecosystem forward, not just a slice of it.

The app is built using vanilla Web Components without using any component publishing libraries like Stencil, Lit and so on. The reason being I met with some roadblocks in building a drag-n-drop editor using these libraries. Actually the Crayons Team itself is using Stencil to build the Crayons components using TypeScript and React-like component semantics and finally publish them as platform native Web components and React wrappers for the same. You can find out more about this in the Stencil documentation.

Stencil

This might sound very similar to the work the Ionic team did with Stencil. The one main difference is that we're not just outputting web components. Rather full framework-ready JavaScript. You can even compile the output to Stencil as well.

While you can build components directly from the supporting Web APIs, you might find it productive to use a library that's been built to support this task. Lit and StencilJS are two of several libraries with acompanying tooling to help you build web components. And because they compile to the same 'target', they give you an additonal advantage: if you choose to switch web component libraries at some point in the future, you can make the switch for new components without having to rewrite the old ones, and use both in the same application.

It's more than just sugar now. You can't even write web components functionally: https://github.com/WICG/webcomponents/issues/587

Does this mean we'll finally get Template-Instantiation[0], providing a native way to do HTML templates in the browser?

There's been a bunch of hand waving that the reason we still don't have this is because they needed a solution for encapsulation and a solution for SSR. Now we have both. Can we please finally deliver on something people have been asking for since the mid 2000s?

[0]: https://github.com/WICG/webcomponents/blob/gh-pages/proposal...

gzip/brotli handles this very well, but it still is text to parse through.

Some form of declarative CSS module scripts would help a lot. A feature request for that here: https://github.com/WICG/webcomponents/issues/939

That's true, but they didn't ratify yet a standard on how to handle web components naming collision, so if you create `my-button` and another developer register `my-button`... Or if you want to use two different version of your own `my-button`...

This is the proposal for scoped elements: https://github.com/WICG/webcomponents/blob/gh-pages/proposal...

In the past I've seen this one:

https://github.com/WICG/webcomponents/blob/gh-pages/proposal...

Perhaps there are more recent versions.

I liked the spirit of the proposal, but never studied it.

No one blocked it. If you're referring to HTML Imports, the problem with them is that they didn't integrate with JS modules. There's a new HTML modules proposal [1], and with JS import assertions and CSS and JSON modules landing [2], HTML modules are probably not far behind.

[1]: https://github.com/WICG/webcomponents/blob/gh-pages/proposal...

Ah, I didn't realize this wasn't solved -- a quick search turns up:

- https://github.com/WICG/webcomponents/issues/788

- https://github.com/w3c/DOM-Parsing/issues/58

- https://github.com/w3ctag/design-reviews/issues/494

- https://web.dev/declarative-shadow-dom

In pre-render they seem to have started in this direction extremely recently:

https://github.com/prerender/prerender/pull/731/files

I don't use prerender so I can't definitively speak to it being solved and hiccup-free, but I think that limitation is going to go away in the future.

this is called an html module: https://github.com/WICG/webcomponents/blob/gh-pages/proposal...

Explainer. PR and discussion followed few days after. Those incubators and WHATWG are of course official.