Component-based UI is all the rage these days. Did you know that the web has its own native component module that doesn't require the use of any libraries? True story! You can write, publish, and reuse single-file components that will work in any* good browser and in any framework (if that's your bag).
In our last post, we learned about the Polymer library and its unique approach to data-binding and app composition.
Lets Build Web Components! Part 4: Polymer Library
Benny Powers ๐ฎ๐ฑ๐จ๐ฆ ใป Oct 14 '18
Today we'll implement <lit-lazy-image>
using the LitElement
base class. Compared to Polymer, LitElement
takes a fundamentally different approach to templating, one which is much more congruent to the reactive style of programming which has become so widespread in front-end in the last few years. With one-way data flow, a declarative syntax for binding data and event listeners, and a standards-based approach to efficient DOM updates, LitElement
s are performant and a pleasure to write.
-
lit-html
LitElement
<lit-lazy-image>
- Attributes and Properties
-
LitElement
Lifecycle - Factoring Apps with
LitElement
But before we dive in, let's take a minute to explore the lit-html
library, which is the foundation of LitElement
lit-html
lit-html
is a new library (currently in pre-release) by Justin Fagnani, an engineer at Google. You use it to write dynamic and expressive DOM templates in JavaScript. If you've worked with React's JSX, you've doubtless written and composed similar templates. Unlike JSX, lit-html
leverages the browser's built-in HTML parser, and standards like the <template>
element and tagged template literals to efficiently update the DOM without any "Virtual DOM" overhead.
Functional UI
With lit-html
templates, we're entering the world of functional programming in JavaScript. We'll be using terms like 'pure' and 'impure' functions a lot in this article, so for an introduction or refresher on functional concepts, check out Brian Lonsdorf's canonical Mostly Adequate Guide to Functional Programming, but for our purposes we'll be interested in a few basic concepts:
- Pure Functions: Functions that take an input and return an output without referencing or affecting any other data.
- Impure Functions: Functions that produce side effects.
-
Side Effects: Anything that happens asides from immediately computing some result from some input, e.g. writing to the
console.log
or thedocument
, or accessing global variables.
So when we say "UI as a function of data", we mean that without having to use anything other than our data, we can compute a piece of UI.
import { html, render } from 'lit-html';
/* lit-html: UI as a pure function of data */
const view = ({ content, title }) =>
html`<h1>${title}</h1>${content}`;
/* Compose templates from other templates */
const title = 'View as a Pure Function of Data';
const content = html`
<p>Composable templates are flexible and powerful. They let you define
complex views from simple building blocks.</p>
<p>Using composition, you can hide implementation details of your
app. This makes your work easier to test, reason about, and debug.</p>`;
/* Everything up to now has been pure. By calling `render`,
* we pull the trigger on the impure part of our app and
* actually write our view to the screen. */
render(view({ content, title }), document.body);
The html
function (template literal tags are just functions) returns a special type called a TemplateResult
, which knows about its static parts and its dynamic parts (or interpolated expressions i.e. the changing ${someExpression}
parts) in its template literals. The render
function takes a TemplateResult
along with a containing node to dynamically update the DOM. By storing the locations in DOM that might react to changing values of expressions in templates, lit-html
can efficiently update those parts of the DOM each render call, without having to re-render the whole tree.
This is similar enough in practice to React's JSX, but let's take a step back to appreciate the differences, so we can make more informed choices. Here is a non-exhaustive list of all the web standards mentioned or alluded to In the previous paragraph:
- Template Literals - JavaScript Strings with powerful interpolation features
- Tagged Template Literals - Specially-written functions that act specifically on Template Literals
-
Template Tags Knowing their Static and Dynamic Parts This isn't a bespoke library feature,
lit-html
leverages the standards - WeakMap to hold the map of template parts to their associated Nodes
Since lit-html
rests exclusively on standards, it runs directly in the browser. It doesn't require any build step, compilation, transforms, or anything like that. In fact I've factored many apps with lit-html using nothing but .js
files - just hit save and refresh!
So, the lit-html
library's raison d'รชtre is to use established, browser-native web standards to let developers write dynamic and expressive HTML-in-JS while handling efficient DOM updates behind the scenes.
For the scoop on that, let's hear it right from the horse' mouth:
Data Binding
In lit-html
templates, you can insert JavaScript expressions in place of any node, or as the value of any attribute. Let's imagine a hypothetical product page where we want to fetch a collection of product objects from our API, then output an HTML template for each.
We can interpolate attribute values with any data we want:
const star = value => html`
<meter class="star-rating"
min="0" max="5"
value="${value}"
></meter>`;
We can declaratively define event listeners by passing in a function with a special @event-type
binding syntax. We'll imagine an example that uses some analytics
function (presumably imported from elsewhere) to report when our product images load on screen.
const lazyThumbnail = ({ id, alt, thumbnail }) => html`
<lazy-image
src="${`https://product-cdn.awesomeshop.com/images/${thumbnail}`}"
alt="${alt}"
@loaded-changed="${event => analytics('thumbnail-viewed', { event, id })}"
></lazy-image>`;
For more control over the listener behaviour, we could pass in a special listener descriptor object. This is also more memory-efficient since it doesn't create a new lambda (i.e. anonymous arrow function) for each render:
const listener = {
handleEvent: event =>
analytics('thumbnail-viewed', {
event, id: event.target.dataset.productId
}),
passive: true,
once: true,
};
const lazyThumbnail = ({ id }) => html`
<lazy-image
data-product-id="${id}"
@loaded-changed="${listener}"
></lazy-image>`;
If we wanted to bind to an element's DOM properties instead of it's HTML attributes, we can use the .property
binding syntax.
html`<img .src="${srcProperty}"/>`;
Note that unlike expensive attribute updates which are guarded to only run when the value actually changes, property assignments happen on each render, whether or not the value has changed. So be careful of calling setters with side effects.
We can also un/set boolean attributes with the special ?attribute
syntax:
const stockBadge = ({ inventory }) => html`
<aside class="badge" ?hidden="${inventory > 0}">
Out of stock!
</aside>`;
In that way, we created a stockBadge
template which displays an 'Out of Stock!' message when the inventory is low, a lazyThumbnail
badge which lazy-loads the product image and notifies our analytics service when it appears on screen, and a star
template which displays a special star-rating via the <meter>
built-in element.
Now we can compose our product template together:
const product = ({ id, rating, thumbnail, alt, url, inventory }) => html`
<article class="product" data-product-id="${id}">
${stockBadge({ inventory })}
${lazyThumbnail({ id, alt, thumbnail })}
${star(rating)}
<a class="btn-link" href="${url}">Read More</a>
</article>`;
With all that in place, generating an entire page's worth of TemplateResult
s would be straightforward:
const productPage = products => products.map(product);
Then, in the impure part of our app, we'd brave the elements to fetch and render our data.
const handleAsJson = response => response.json();
const renderToProductContainer = templateResult =>
render(templateResult, document.getElementById('products'))
fetch('/api/products?page=1') // Fetch the array of products
.then(handleAsJson) // Parse the response as JSON
.then(productPage) // Map `product` over the array,
// converting it to an array of TemplateResults.
.then(renderToProductContainer) // Render the templates to the DOM.
Directives
lit-html
comes with a variety of template helper functions called directives. They are meant to be called inside of a template definition. They interact with the internal lit-html
APIs that compute TemplateResults
, usually to improve rendering performance.
import { repeat } from 'lit-html/directives/repeat.js';
import { ifDefined } from 'lit-html/directives/if-defined.js';
const getId = ({ id }) => id;
const stooges = [
{ id: 1, name: 'Larry', img: 'images/larry.jpg' },
{ id: 2, name: 'Curly' },
{ id: 3, name: 'Moe', img: 'image/moe.jpg' }
];
const stoogeTpl = ({ id, name, img }) => html`
<li data-stooge="${id}">
<img src="${ifDefined(img)}"/>
</li>`;
const stoogesTpl = html`<ul>${repeat(stooges, getId, stoogeTpl)}</ul>`;
The repeat
directive is used like Array#map
to generate a list of templates from an Array. As of this writing it appears that for most use cases Array#map
is just as if not more performant than repeat
. But for cases where you will be changing the order of a large list of items that have their own IDs, repeat
is where it's at.
ifDefined
is used to check if a value is defined before outputting the associated DOM. It's useful when you only want to apply an attribute in the case that your value exists, like we've done with <img src>
above.
The until
directive can be used to wait on a promise, showing some default content in the mean time.
html`<h1>${until({
this.userPromise.then(user => user.name),
'Loading User...'
})}</h1>`;
The when
directive functions just like the ternary (x ? y : z
) expression, but it's lazy. You pass an expression, and two functions that return TemplateResult
s for the truthy and falsy cases of some expression, they will only be evaluated as needed.
const postTpl = ({ title, summary }) => html`
<dt>${title}</dt>
<dd>${summary}</dd>`
const userPostsTpl = ({ name, posts = [] }) => html`
<h1>${name}'s Posts</h1>
<dl>${posts.map(postTpl)}</dl>`
const loggedOutTpl = () => html`
<h1>Log in to see your posts</h1>
<mwc-button @click="${login}">Login</mwc-button>`
const userPageTpl = (user = { loggedIn: false }) => html`
<header>
${when(user.loggedIn, () => userPostsTpl(user), loggedOutTpl)}
</header>`;
The guard
directive prevents a re-render until an expression's identity changes (meaning, if you change the expression from one primitive to another or from one object reference to another, even if the object's contents are equivalent)
The classMap
and styleMap
directives help you set classes and styles on your components in a more efficient manner
// Because of lit-html internals, this is inefficient.
const userTpl = ({ token, name }) =>
html`<div class="user ${ token ? 'loggedIn' : '' }">${name}</div>`;
// Using `classMap` instead keeps your templates efficient.
const userTpl = ({ token, name }) =>
html`<div class="${classMap({ loggedIn: token, user: true })}">${name}</div>`;
The directives APIs are some of the last to be finalized before ye olde big 1.0 launch, so stay up to date by checking the README and the documentation
LitElement
You can and should use lit-html
on its own in your projects. But we're here to talk web components. It just so happens to be that the LitElement
base class is the official custom element class for working with lit-html
.
If lit-html
is about computing UI with pure functions, then LitElement
is about hitching that mechanism to a very object-oriented customElement
class. When you extend from it and provide a render()
method that returns a TemplateResult
, LitElement
takes care of batching DOM updates for you.
import { LitElement, html } from 'lit-element';
const superlativeTpl = superlative =>
html`<li>So <em>${superlative}</em>!!</li>`
class SoLit extends LitElement {
static get properties() {
return {
title: { type: String },
superlatives: { type: {
fromAttribute: attr => attr.split(','),
toAttribute: xs => xs.join(),
} },
}
}
render() {
return html`
<h1>${this.title}</h1>
<p>Proof:</p>
<ul>${this.superlatives.map(superlativeTpl)}</ul>
`;
}
}
With this brief introduction to the new hotness that lit-html
and LitElement
bring, we're ready to start our refactor of <lazy-image>
.
<lit-lazy-image>
Just like last week, our first step will be to import our dependencies and rename the component.
import { LitElement, html } from 'lit-element';
const isIntersecting = ({isIntersecting}) => isIntersecting;
const tagName = 'lit-lazy-image';
class LitLazyImage extends LitElement {/*..*/}
customElements.define(tagName, LitLazyImage);
Next we'll define our render method, using <polymer-lazy-image>
's as a template (pun!), but replacing the static binding expression strings with JS expressions, and adjusting the binding syntax. All of the styles will stay the same as the ones we used for <polymer-lazy-image>
.
render() {
return html`
<style>/*...*/</style>
<div id="placeholder" aria-hidden="${String(!!this.intersecting)}">
<slot name="placeholder"></slot>
</div>
<img id="image"
aria-hidden="${String(!this.intersecting)}"
.src="${this.intersecting ? this.src : undefined}"
alt="${this.alt}"
@load="${this.onLoad}"
/>
`;
}
Since we can interpolate actual JavaScript expressions, we don't need any of the computed binding methods from our polymer-based implementation. We likewise don't need the property getters and setters from the vanilla version, since LitElement has its own mechanism for managing properties and attributes. We'll discuss LitElement's properties system in more depth later on.. For now, it's enough to define our observed attributes in a static getter:
static get properties() {
return {
alt: { type: String },
intersecting: { type: Boolean },
src: { type: String },
loaded: {
type: Boolean,
reflect: true,
},
}
}
And really, that's basically it. One small change I made was to explicitly fire a loaded-changed
event when the image loads up, to maintain compatibility with Polymer-style templating systems:
onLoad(event) {
this.loaded = true;
// Dispatch an event that supports Polymer two-way binding.
this.dispatchEvent(
new CustomEvent('loaded-changed', {
bubbles: true,
composed: true,
detail: {
value: true,
},
})
);
}
And I took the opportunity to refactor initIntersectionObserver
to handle its own feature detection:
initIntersectionObserver() {
// if IntersectionObserver is unavailable,
// simply load the image.
if (!('IntersectionObserver' in window)) {
return this.intersecting = true;
}
// ...
}
But the truth is that thanks to lit-html
, we've deleted a lot more than we've added here.
Here's our completed component, Check out the diff, down to 140 LOC from <polymer-lazy-image>
's 160 and <lazy-image>
's 195:
import { LitElement, html } from 'lit-element';
const isIntersecting = ({isIntersecting}) => isIntersecting;
const tagName = 'lit-lazy-image';
class LitLazyImage extends LitElement {
render() {
return html`
<style>
:host {
position: relative;
}
#image,
#placeholder ::slotted(*) {
position: absolute;
top: 0;
left: 0;
transition:
opacity
var(--lazy-image-fade-duration, 0.3s)
var(--lazy-image-fade-easing, ease);
object-fit: var(--lazy-image-fit, contain);
width: var(--lazy-image-width, 100%);
height: var(--lazy-image-height, 100%);
}
#placeholder ::slotted(*),
:host([loaded]) #image {
opacity: 1;
}
#image,
:host([loaded]) #placeholder ::slotted(*) {
opacity: 0;
}
</style>
<div id="placeholder" aria-hidden="${String(!!this.intersecting)}">
<slot name="placeholder"></slot>
</div>
<img id="image"
aria-hidden="${String(!this.intersecting)}"
.src="${this.intersecting ? this.src : undefined}"
alt="${this.alt}"
@load="${this.onLoad}"
/>
`;
}
static get properties() {
return {
/**
* Image alt-text.
* @type {String}
*/
alt: { type: String },
/**
* Whether the element is on screen.
* @type {Boolean}
*/
intersecting: { type: Boolean },
/**
* Image URI.
* @type {String}
*/
src: { type: String },
/**
* Whether the image has loaded.
* @type {Boolean}
*/
loaded: {
type: Boolean,
reflect: true,
},
}
}
constructor() {
super();
this.observerCallback = this.observerCallback.bind(this);
this.intersecting = false;
this.loading = false;
}
connectedCallback() {
super.connectedCallback();
// Remove the wrapping `<lazy-image>` element from the a11y tree.
this.setAttribute('role', 'presentation');
// if IntersectionObserver is available, initialize it.
this.initIntersectionObserver();
}
disconnectedCallback() {
super.disconnectedCallback();
this.disconnectObserver();
}
/**
* Sets the `intersecting` property when the element is on screen.
* @param {[IntersectionObserverEntry]} entries
* @protected
*/
observerCallback(entries) {
if (entries.some(isIntersecting)) this.intersecting = true;
}
/**
* Sets the `loaded` property when the image is finished loading.
* @protected
*/
onLoad(event) {
this.loaded = true;
// Dispatch an event that supports Polymer two-way binding.
const bubbles = true;
const composed = true;
const detail = { value: true };
this.dispatchEvent(new CustomEvent('loaded-changed', { bubbles, composed, detail }));
}
/**
* Initializes the IntersectionObserver when the element instantiates.
* @protected
*/
initIntersectionObserver() {
// if IntersectionObserver is unavailable, simply load the image.
if (!('IntersectionObserver' in window)) return this.intersecting = true;
// Short-circuit if observer has already initialized.
if (this.observer) return;
// Start loading the image 10px before it appears on screen
const rootMargin = '10px';
this.observer = new IntersectionObserver(this.observerCallback, { rootMargin });
this.observer.observe(this);
}
/**
* Disconnects and unloads the IntersectionObserver.
* @protected
*/
disconnectObserver() {
this.observer.disconnect();
this.observer = null;
delete this.observer;
}
}
customElements.define(tagName, LitLazyImage);
There's much more to learn about LitElement
than our simple lazy-loading example demonstrates. Let's dive in to the API and see what we can see.
Attributes and Properties
LitElement
comes with the ability to define property and attribute descriptors. These are similar to the ones we used with PolymerElement
last week, but LitElement
's are at once more powerful and more flexible.
Any property defined in the static properties
getter will be added to the list of observedAttributes
(for more on that, see our piece on vanilla web components). For simple cases, you can just pass the type constructor of the property.
/**
* When the `simple` attribute is set,
* it will also set the `simple` property
*/
simple: { type: String },
Reflecting Properties to Attributes
If you'd like to reflect changes to the property as an attribute, flag the reflect
boolean in the property descriptor.
/**
* Just like `simple`, but it will also set the `reflecting`
* attribute when the `reflecting` property is set.
*/
reflecting: {
type: Number, // defaults to `String`
reflect: true,
},
You can also set the attribute
descriptor to specify which attribute to synchronize with.
/**
* Like `string` and `reflect`, but this time syncs to the
* `special-attribute` attribute. If `attribute` is not specified,
* it will sync with the lowercase property name
* i.e. `definedattr`
*/
definedAttr: {
type: String,
attribute: 'special-attribute', // defaults to `true`
reflect: true,
},
The attribute
descriptor can be either false
, in which case the attribute won't be observed (but setting the DOM property will still run LitElement
effects); true
, in which case the ascii lowercased property name will be observed; or a string, in which case that specific string will be observed for that property.
Controlling Serialization
Serialization means converting data like numbers, arrays, or objects, to a format that can reliably be sent one piece at a time, like a string. It happens to be that all HTML attribute values are strings, so when we talk about serialization w.r.t. DOM properties, we're talking stringification.
If you want to control how that process works in your element, you can specify in the type
descriptor a function to handle serialization (defaults to the String
constructor). For fine-grained control over the process, set type
to an object with functions at the properties fromAttribute
and toAttribute
.
<super-serializer serialized="a|b|c|d"></super-serializer>
<script type="module">
import { LitElement } from 'lit-element';
class extends LitElement {
static get properties() {
return {
serialized: {
type: {
fromAttribute: x => x.split('|')
toAttribute: xs => xs.join('|')
}
}
}
}
};
customElements.define('super-serializer', SuperSerializer);
const el = document.querySelector('super-serializer');
(async () => {
console.log(el.serialized); // ["a", "b", "c", "d"]
el.serialized = [1, 2, 3, 4];
await el.updateComplete;
console.log(el.serialized); // [1, 2, 3, 4]
console.log(el.getAttribute('serialized')) // "1|2|3|4"
})();
</script>
Determining when a Property Has Changed
You can control how your element will react to property changes by setting the hasChanged
property of a property descriptor to a predicate function (meaning, a function that returns a Boolean). This will be pretty useful when your property is a reference type like Object
or Array
.
The signature of the hasChanged
function is (newVal, oldVal) -> Boolean
, so you could do something like:
const userType = {
fromAttribute: id => getUserSync(users, id),
toAttribute: ({ id }) => id,
};
const userHasChanged = (
{ id, avatar, name } = {},
{ id: oldId, avatar: oldAvatar, name: oldName } = {}
) => (
id !== oldId ||
avatar !== oldAvatar ||
name !== oldName
);
static get properties() {
return {
user: {
type: userType,
hasChanged: userHasChanged,
}
}
}
You'd use hasChanged
for fine-grained control over the element's lifecycle on a per-property basis. There are also a number of methods that you can implement in your element to affect how the lifecycle turns.
LitElement
Lifecycle
In addition to the standard custom element lifecycle callbacks, LitElement
provides a number of specific methods which help you control how and when your element renders.
shouldUpdate
To control whether or not your element re-renders, implement the shouldUpdate
function which takes a Map
of changed properties, which refers to the old values.
shouldUpdate(changedProperties) {
return !changedProperties.has('dataOnlyProp') || changed;
}
By default, shouldUpdate
returns true
.
update
We've already seen the render
method, which determines the element's template. render
is called by the update
method, which, like shouldUpdate
, takes a Map
of changed properties. You might use update
to perform side-effects not related to the DOM. Don't manipulate properties here, since setting them won't trigger another update.
update(changedProperties) {
// Don't forget this or your element won't render!
super.update(changedProperties);
if (changedProperties.get('loggedIn') && !this.loginReported) {
Analytics.report('Logged In', this.user.id)
this.loginReported = true;
}
}
firstUpdated
and updated
But if you want to perform side effects related to the DOM, like getting a reference to a shadow-child or setting a light-child attribute, you should use either firstUpdated
or updated
:
/**
* firstUpdated runs once after the element renders for
* the first time. It's ideal for capturing references to
* shadow children, etc.
* @param {Map<string, any>} changedProperties
*/
firstUpdated(changedProperties) {
// Capture references to shadow children.
this.player = this.shadowRoot.querySelector('video');
// Setting observed properties here will trigger an update.
this.loaded = true;
}
/**
* Updated runs every time the element renders, so it's well-
* suited for managing light DOM children, or anything else that you
* don't directly control in your template.
* @param {Map<string, any>} changedProperties
*/
updated(changedProperties) {
this.children.forEach(child => setAttribute('updated', new Date()))
super.updated(changedProperties);
}
Setting observed properties in either firstUpdated
or updated
will trigger a re-render.
requestUpdate
The requestUpdate
method which will explicitly cause the element to update and re-render. You can call this method in one of two ways. Calling without arguments will simply re-render the element. This is useful when for example you want to set some element state based on something other than properties, like light DOM children.
// Get a DOM reference to your element
const myLitEl = document.querySelector('my-lit-element');
// When the element's light DOM mutates, call `requestUpdate`
const onMutation = ([{target}]) => target.requestUpdate();
const observer = new MutationObserver(onMutation);
observer.observe(myLitEl, {
attributes: false,
childList: true,
subtree: true,
});
When you call requestUpdate
with a specific property and value, LitElement
will run the side effects configured for that property, for example reflecting its attribute. You should do this if you've implemented setters for your properties.
set customProp(value) {
// Do your thing, we try not to judge - honest!
weirdSideEffect(value);
// Make sure LitElement has its house in order.
this.requestUpdate('customProp', this.customProp)
}
updateComplete
The updateComplete
property (NOTE: Not a method!!) is a promise that resolves when rendering is finished. You'll notice we've used it in some of our earlier examples. Wait for this promise when you want to access the updated DOM.
class MouseMachine extends LitElement {
static get properties() {
return {
meaning: {
type: String,
attribute: 'life-the-universe-and-everything',
},
};
}
};
customElements.define('mouse-machine', MouseMachine);
const mm = document.createElement('mouse-machine');
document.body.append(mm);
(async () => {
mm.meaning = 42;
await mm.updateComplete;
console.log(myLitEl.getAttribute('life-the-universe-and-everything'));
});
Factoring Apps with LitElement
Unlike Polymer elements, with their two-way-binding templates, lit elements are particularly well suited to the types of one-way data flows popularized by the React/Redux pattern and others. You can create or import class mixins which connect your elements to your central store and update their props. In fact, I've released a set of base classes which extend from LitElement
that connect your components to an Apollo GraphQL client cache. Check it out:
apollo-elements / apollo-elements
๐๐ Use the Launch Platform ๐ฉโ๐๐จโ๐
๐ Apollo Elements ๐ฉโ๐
๐ Custom elements meet Apollo GraphQL ๐
๐ฉโ๐ It's one small step for a dev, one giant leap for the web platform! ๐จโ๐
Apollo Elements offers packages based on a variety of underlying web component authoring libraries. You can pick the one that suits your project in order to keep your app sizes small.
npm init @apollo-elements
๐ค Demos
-
#leeway
is an example chat PWA that useslit-apollo
to make it easier for you to avoid doing actual work. Source Repository -
LaunchCTL
is a simple PWA that displays info about SpaceX launches. It uses the unofficial spacex.land GraphQL API. Source Repository
๐บ Guides and Docs
If you just want to see the API Docs, check them out for all our packages at apolloelements.dev
- ๐ฅ Core
- ๐งฑ Components
- ๐ธ Mixins
- ๐ฅ Lit
- ๐ FAST
- ๐ป Haunted
- โ๏ธ Atomico
- ๐ฆ Hybrids
- ๐ฌ Gluon
- ๐งฌ Polymer
Use in any
โฆhe PWA Starter Kit is a fully-realised example of an app factored with LitElement
and Redux
.
Polymer / pwa-starter-kit
Starter templates for building full-featured Progressive Web Apps from web components.
Status: No longer under development
This project is no longer under development.
If you're interested in continuing to use PWA Starter Kit, feel free to fork and modify it as you like.
If you want to start a new application project using LitElement, the open-wc application scaffold generator is one good starting point.
PWA Starter Kit
This sample app is a starting point for building PWAs. Out of the box, the template gives you the following features:
- all the PWA goodness (manifest, service worker)
- a responsive layout
- application theming
- example of using Redux for state management
- offline UI
- simple routing solution
- fast time-to-interactive and first-paint through the PRPL pattern
- easy deployment to prpl-server or static hosting
- unit and integrating testing starting points
- documentation about other advanced patterns.
๐ Head over to the documentation site for more details or check out how to get started!
TODOs
- Setup Safari testing onโฆ
But since lit-elements are just DOM, you can set their properties with vanilla JavaScript, which means that you can use any state management solution that speaks JavaScript, pre-made or bespoke.
A future post will go more into detail about options for factoring web-component-based apps, so stay tuned!
Conclusions
Pros | Cons |
---|---|
Functional UI with lit-html and LitElement | Coming from Polymer's two-way binding, it's a change in paradigm. |
Based in web standards, no need for babel, typescript, or long toolchains. | The one non-standard usage is bare specifiers, requiring either a bundler or a server-side transform. |
Aligns well with patterns and syntax familiar to many popular libraries | Although the community is vocal and growing, it's not yet as large and popular as other libraries (at least, not until you get involved, dear reader) |
LitElement
is set to be the go-to custom element base class for most projects, but it's far from the only game in town. Join us next week to look at Gluon, a slimmed-down and simple custom elements framework that gives you key features without the bloat.
See you then ๐
Would you like a one-on-one mentoring session on any of the topics covered here?
Acknowledgements
Thanks again are due to @ruphin for sharing his insights into lit-html
and the web components standards, and to Amit Merin and morbidick in the Polymer community slack for their proofreading.
Errata
- Since this post was originally published, lit-html 1.0 and lit-element 2.0 stable were released. The pros/cons table has been updated to reflect that.
Check out the next article in the series
Top comments (21)
Benny; thank you so much for these excellent articles!
I do have a question for you. Now that you've been into litHtml and litElements for a few years now, do you still feel this is the best way to go with respect to web components?
It all looks very good to me, but I don't see widespread adoption. I don't really care what the adoption rates look like if the framework is hands down the best. I'm willing to put time into it if it is the best one.
Any advice?
Hi John, thanks for the kind words
Yes, I do consider
LitElement
to be the best option for making web components in September 2020, for these reasons:Platform
Of all the major ways to make a web component that I'm aware of,
LitElement
strikes the best balance between providing features the web platform doesn't (reactive updates, data->ui templating), while still respecting and leaning on existing APIs. ALitElement
factors, reads, and behaves exactly what it is - a spicyHTMLElement
.That also means that more of the knowledge you gain from working with
LitElement
is transferable. I've often had the experience working with developers familiar with a certain popular web framework of them asking me about "how to do X with lit", only to realize after considering their question that they really wanted to know how to do X with the DOM, or CSS, or JavaScript.To be certain,
LitElement
has some opinions of its own, notably asynchronous rendering andupdateComplete
(which is actually kind of a super power), and you'll have fun getting to know how to take advantage of them, but most of the action here is web standards.Simplicity
To paraphrase @webpadawan - when Vaadin was evaluating
LitElement
for adoption, one of the selling points for them was that it was simple enough to grok on its own that if they ever needed to, they could fork and maintain their own version without too much trouble. lit-html andLitElement
have relatively few moving parts. With some dedication and a pot of coffee, you could probably get through the codebase in an afternoon. The github.com/Polymer/lit-element has about ~1700 lines of idiomatic TypeScript. github.com/Polymer/lit-html has about 3471 (2080 if you don't count the directives). And the next major versions will be smaller and faster, with more stuff opt-in.Adoption
I'm unfortunately still aware that a certain type of personality in the industry would prefer we all think that no one's using web components, but they're gaining adoption among small and large companies. Now, npm download stats don't tell us as much as we think they do, but nonetheless, lit-element is gaining on its peers
Community
Come join us in the Polymer Slack (I know, slack... what can we do). It's a welcoming, helpful and passionate community.
TL;DR
So yeah,
LitElement
is where it's at, and I hope you have a tonne of fun learning and using it.Just curious Benny; how long have you been working with it?
It just seems almost too good to be true, but then again it's coming from the strong folks at Google, who have more than proved themselves with Angular and other things like the V8 Engine and Node.js.
I liked React in the beginning but not so much now. I think it's highly opinionated.
I've been using web components since polymer 1. You can think of LitElement like polymer 4.
With LitElement and a nice modern toolchain your going to get a very similar developer experience, but with less overhead.
Check out modern-web.dev and open-wc.org for more
Hi Benny,
Thanks for this article. I have a question, I have a use case where I have to write a module which should work on React, AngularJS and Angular 2+.
So i thought to create a web component for it and use it on all other frameworks. I was wondering that how to deploy the web component code and use it in other frameworks.
It would be really helpful of you if you could help me with any example.
Thanks in advance.
You're spot on. You should definitely publish a web component for this case.
Take a look at open-wc's recommendations on publishing
open-wc.org/guides/developing-comp...
Thank you Benny. At the moment I'm exploring which framework or library to use, so far have explored lit and stenciljs. I'm getting attracted towards stencil.js as I can get community help for stencil more than lit.
Thank you for your reply. I will check this documentation and then will finalize which one to use. :)
join the Lit and Friends Slack for community support
lit.dev/slack-invite/
Congratullations! Excellent article! You wrote "Unlike Polymer elements, with their two-way-binding templates, lit elements are particularly well suited to the types of one-way data flows popularized by the React/Redux pattern and others". Do you mean that lit elements isn't well suited for a webcompnent where the user enters data? You mentioned stock. I can imagine easily a webcomponent exposing stock status as an one-way (only from server to front). And if you was webcomponent for a shopping (from front to server)? Wouldn't you recommend lit-html? If so, what do you recomend if I want to create a webcomponent to be part of my corporarte webcomponet library and used for user inputs?
Just the opposite. Because of the one-way data flow, lit-html encourages you to explicitly and declaratively handle user input.
Polymer-Style Two-Way
At any given moment, what does
theValue
represent? Is it the state held by the parent and passing down to the child? Is it the new input being sent up to the parent by<my-input>
?One-Way Binding with lit-html
Here, the developer knows exactly what's happenning.
theValue
is only ever passed down to<my-input>
.input
events are handled byonInput
(which might set the state in the parent, or in a state container, or whatever you choose)So for your company's component library, I recommend either implementing a decorator component:
Or implementing
<input>
in the root of<my-input>
, and listening for the composedchange
event on that. Make sure to handle your state internally, e.g.this is a great article. the cons part needs to be updated. since you've written this, both lit-html and lit-element are stable
Thanks Florin, I've updated the content
Thanks, I'll be publishing some updates to this article shortly
I am still confused on why I will want to convert properties to attributes and vice versa. Can you give me one use case?
Hey, sure
So, properties exist on the DOM, which is the browser's JavaScript object representation of the Document, but they don't exist at all in the document's HTML markup.
One big difference between the two is that (for the most part), CSS can't see the DOM, it can only see the markup.
Here, we use
reflect: true
in the property descriptor forXElement#schwifty
to indicate that setting the property should reflect to the attribute.That could be useful for a document author, for example with this css:
Another use case along these lines could be setting a
disabled
attribute, or setting ARIA attributes based on an element's DOM state. I set theerror
attribute based on a caught error'smessage
property in<stripe-elements>
, as a convenience while debugging.You can similarly think of cases where a component author would specifically not want to leak internal state outwards to the document, like when some intermediate value is observed so that it causes re-render, while remaining a private 'implementation detail' of the element:
Thank you!
Small edit to the second example: set
content
descriptor withattribute: false
, It can only be set with a property nowHi, Benny. Great post. I have a question: is there a package like React's Enzyme for Web Components to use with Jest? Or what option could I choose for TDD?
Take a look at open-wc.org/testing
Thanks Benny! I ended up with Karma and Mocha :)
Great! It's what I'm using for Apollo Elements and so far so good