Web Components the Right Way

A curated list of awesome Web Components resources.

Web Components — a suite of different technologies allowing you to create reusable custom elements — with their functionality encapsulated away from the rest of your code — and utilize them in your web apps.

Introduction
Standards
Polyfills
Guides
Articles
Real World
Libraries
Frameworks
- Angular
- React
- Vue
- Svelte
Ecosystem
- Starter Kits
- Tools
Books
Tutorials
Insights
Usage Metrics
Proposals
Miscellaneous
History
Who to follow
License

Web Components the Right Way was made with love by Mateus Ortiz and maintained by Serhii Kulykov

Introduction

Standards

Custom Elements

Custom Elements provide a way for authors to build their own fully-featured DOM elements.

Shadow DOM

Shadow DOM describes a method of combining multiple DOM trees into one hierarchy and how these trees interact with each other within a document, thus enabling better composition of the DOM.

HTML Templates

<template> element is used to declare fragments of HTML that can be cloned and inserted in the document by script.

CSS Shadow Parts

CSS Shadow Parts allow developers to expose certain elements inside Shadow DOM for styling purposes.

Polyfills

Custom Elements polyfills

@webcomponents/custom-elements - Custom Elements polyfill by Polymer team.
document-register-element - Custom Elements polyfill by Andrea Giammarchi.

Customized Built-in Elements polyfills

@corpuscule/custom-builtin-elements - Customized built-in elements polyfill by CorpusculeJS.
@ungap/custom-elements-builtin - Customized built-in elements polyfill by ungap project.

Shadow DOM shims

@webcomponents/shadydom - ShadowDOM v1 shim.
@webcomponents/shadycss - ShadowDOM style encapsulation shim.
@lwc/synthetic-shadow - Shadow DOM polyfill by LWC.

HTML Templates polyfills

@webcomponents/template - Minimal polyfill for <template>.
@ungap/import-node - An importNode polyfill for IE11 by ungap project.

Guides

Accessibility

Best Practices

Codelabs

Examples

generic-components - Collection of generic web components with a focus on accessibility, and ease of use.
howto-components - Collection of web components that implement common web UI patterns.
open-wc code examples - Collection of best practices and design patterns for developing web components.
vanilla-retro-js - Vanilla JS UI component library of HTML deprecated tags.
web-components-examples - Series of web components examples, related to the MDN web components documentation.

Articles

Architecture

Interoperability

Limitations

Styling

Real World

Case Studies

Components

<api-viewer> - API documentation and live playground for Web Components.
<chess-board> - Standalone chess board web component.
<css-doodle> - Web component for drawing patterns with CSS.
<dark-mode-toggle> - Custom element that allows to create a dark mode toggle or switch.
<emoji-picker> - Lightweight emoji picker, distributed as a web component.
<fg-modal> - Accessible modal dialog web component.
<file-viewer> - Web component built with Svelte to view files.
<json-viewer> - Web component to visualize JSON data in a tree view.
<lite-youtube> - Lite YouTube embed with a focus on visual performance.
<midi-player> - MIDI file player and visualizer web components.
<model-viewer> - Web component for rendering interactive 3D models.
<player-x> - Media player web component.
<progressive-image> - Custom element to progressively enhance image placeholders.
<range-slider> - Accessible range slider custom element with keyboard support.
<rapi-doc> - Web component for creating documentation from OpenAPI Specification.
<shader-doodle> - Web component for writing and rendering shaders.
<trix-editor> - Rich text editor custom element for everyday writing.
<vime-player> - Customizable, extensible, accessible and framework agnostic media player.
<web-vitals> - Bring web vitals quickly into your page using custom elements.

Component Libraries

AMP - Web component framework for easily creating user-first websites, stories, ads, emails and more.
Apollo Elements - Custom elements for using Apollo GraphQL with various web components libraries.
AXA Pattern Library - AXA CH UI components library built with Web Components.
Blackstone UI - Web components for creating interfaces by Blackstone Publishing.
Blaze UI Atoms - Set of web components powered by Blaze CSS.
Brightspace UI core - Collection of web components for building Brightspace applications.
Clever components - Collection of Web Components made by Clever Cloud.
DataFormsJS - Standalone Components for SPA routing, displaying data from web services, and more.
elements-sk - Collection of custom elements for "a la carte" web development.
github-elements - GitHub's Web Component collection.
Elix - High-quality, customizable web components for common user interface patterns.
Immersive Custom Elements - Set of web components for embedding immersive (VR & AR) content.
Iooxa - Web components for interactive scientific writing, reactive documents and explorable explanations.
Joomla UI custom elements - Compilation of Joomla 4 Custom Elements.
Ketch.UP - Web components library for Sme.UP.
Lion Web Components - Set of highly performant, accessible and flexible Web Components.
LRNWebComponents - ELMS:LN produced web components for any project.
Lume - Custom elements for defining 2D or 3D scenes rendered with CSS3D or WebGL.
Microsoft Graph Toolkit - Collection of web components for the Microsoft Graph.
Nightingale - Data visualisation web components for the life sciences.
Nuxeo Elements - Components for building web applications with Nuxeo using Web Components.
Open Business Application Platform Web Components - Collection of web components designed for business applications.
Pixano Elements - Re-usable web components dedicated to data annotation tasks.
Shoelace - A forward-thinking library of web components.
Smart Web Components - Web components for business applications.
TEI Publisher Components - Collection of web components used by TEI Publisher and apps generated by it.
Tradeshift Elements - Reusable Tradeshift UI Components as Web Components.
Vaadin components - Evolving set of high-quality web components for building business web applications.
Warp View - Collection of charting web components for Warp 10.
Wired Elements - Set of common UI elements with a hand-drawn, sketchy look.
Wokwi Elements - Web Components for Arduino and various electronic parts.
XWeather - Collection of web components implementing portions of the OpenWeatherMap API.

Design Systems

Amber Components - Web Components implementation of the Amber Design System.
Bolt Design System - Twig and Web Component-powered UI components, reusable visual styles and tooling.
Calcite Components - Shared Web Components for Esri's Calcite design framework.
Carbon Custom Elements - Carbon Design System variant on top of Web Components.
Chameleon Web Components - Collection of framework-agnostic elements based on the Chameleon Design System.
Clarity Core Web Components - Suite of web components from the Clarity Design System.
Crayons - Collection of web components that adheres to the Freshworks Design System.
FAST Components - Library of Web Components based on the FAST design language.
Fluent UI Web Components - Library of Web Components that supports Microsoft's Fluent design language.
GOV.UK Web Components - Set of encapsulated web components consuming the GOV.UK Design System.
Helix UI - Web Component library for the Helix Design System.
Lyne Components - Building blocks of the Lyne Design System are based on Web Components.
Material Web Components - Material Design implemented as Web Components.
NuML | NUDE Elements - HTML Framework and Design System based on Web Components and runtime CSS generation.
PatternFly Elements - Collection of flexible and lightweight Web Components based on the Unified Design Kit.
Pearson Web Components - Pearson's shareable component library implementing Gravity design system.
Spectrum Web Components - Adobe Spectrum design language implementation built with Web Components.
UI5 Web Components - Set of reusable UI elements implementing SAP Fiori Design Guidelines.
U-M Library Design System - University of Michigan Library Design System.
Zooplus web components - Set of web components that implement Z+ shop style guide.

Use Cases

Libraries

Class Based

Corpuscule - Small Web Components framework based on decorators.
DNA - Progressive Web Components library.
FAST Element - Lightweight library for building performant, memory-efficient, standards-compliant Web Components.
LitElement - Simple base class for creating fast, lightweight web components. Part of the Polymer Project.
Lightning Web Components - blazing fast, enterprise-grade Web Components foundation.
Omi - Next generation web framework in 4kb JavaScript (Web Components + JSX + Proxy + Store + Path Updating).
Panel - Web Components + Virtual DOM: web standards for powerful UIs.
Polymer - Original web component library by the Polymer Project authors.
Skate - Web component library focusing on a functional rendering pipeline and a small footprint.
slim.js - Fast & Robust Front-End Micro-framework based on modern standards.
Stencil - Compiler for generating Web Components.
Tonic - Minimalist, stable, audit friendly component framework.

Functional

atomico - Small library for the creation of interfaces based on web components using functions and hooks.
fuco - Functional component like React, but for Web Components.
haunted - React's Hooks API implemented for web components.
hybrids - UI library for creating Web Components with simple and functional API.
Solid - Declarative JavaScript library for creating user interfaces.

Integrations

ember-custom-elements - Render Ember and Glimmer components using custom elements.
preact-custom-element - Generate/register a custom element from a preact component.
@adobe/react-webcomponent - Automate the wrapping of a React component in a custom element.
react-shadow - Utilise Shadow DOM in React with all the benefits of style encapsulation.
reactify-wc - Use web components with React properties and functions.
remount - Mount React components to the DOM using custom elements.
@riotjs/custom-elements - Simple API to create vanilla custom elements with Riot.js.

Benchmarks

All the Ways to Make a Web Component
web-components-benchmark - Benchmark Web Components technologies with various examples.
web-components-todo - The same todo application built in different Web Components libraries for benchmark purpose.

Frameworks

Angular

React

Vue

Svelte

Ecosystem

Starter Kits

Create Open Web Components - Web component project scaffolding.
custom-element-boilerplate - Boilerplate for creating a custom element.
hello-web-components - Simple starter hello world web component written in TypeScript.
nutmeg - Build, test, and publish vanilla Web Components with a little spice.

Tools

Custom Elements Locator - Chrome extension to find custom elements on a page.
query-selector-shadow-dom - querySelector that can pierce Shadow DOM roots, useful for automated testing.
shadow-automation-selenium - Shadow DOM automation using Selenium.
shadow-dom-utils - Set of useful utilities for dealing with shadow DOM, primarily for test environment.
@storybook/web-components - UI development environment for plain web-component snippets.
webcomponents.dev - Component IDE for web platform developers.
web-component-analyzer - CLI that analyzes web components and emits documentation / diagnostics.
Web Components Codemods - Codemods for Web Components.

Books

Web Components in Action - Book by Ben Farrell, available at Manning early release program.
Web Component Essentials - Book by Cory Rylan, early preview edition available at Leanpub.

Tutorials

"Let's Build Web Components!" by Benny Powers
"Web components: from zero to hero" by Pascal Schilp
"The Modern JavaScript Tutorial" by Ilya Kantor
"HowTo: Components" by Web Fundamentals
CSS tricks article series by Caleb Williams
Angular Elements article series by Manfred Steyer

Insights

Podcasts

Presentations

Talks

Usage Metrics

Proposals

Form-associated Custom Elements

Form Participation API Explained - Document by Google Chrome team.
Form-associated custom elements - Feature in Chrome platform status.
web-platform-tests

Custom State Pseudo class

Constructable Stylesheet Objects

Specification Draft
web-platform-tests
Explainer
Constructable Stylesheets - Feature in Chrome platform status.

Miscellaneous

bruck - Prototyping system built with web components and the Houdini Paint API.
Vaadin Directory - Publish, discuss and rate web components
webcomponents.org - Discuss & share web components.

History

The articles below represent a long story of the Web Components specifications on the way towards the standardization. Some of them refer to earlier, so-called "v0" Shadow DOM and Custom Elements specs, and abandoned HTML Imports spec. These materials are here for historical reasons only, they are grouped by years and listed in chronological order.

2019

2018

2017

2016

2015

2014

2013

2012

2011

Who To Follow

Polymer	Stencil	open-wc.org	webcomponents.dev
Justin Fagnani	Viljami Salminen	Jan Miksovsky	Serhii Kulykov

License

Code licensed under the: MIT license

@author Mateus Ortiz [email protected]

lenamax2355 / webcomponents-the-right-way Goto Github PK