Acknowledgements

The beginning of your journey with Web Components.

Foreword

A brief introduction to the set of specifications called Web Components. We'll introduce you to concepts such as Shadow DOM, HTML templates, Custom Elements v1 and uncover typical use cases for developing Web Components.

Introduction to Web Components

We'll introduce you to the mockups in Figma, the development environment used throughout the book, and other conventions used in this book.

Conventions Used In The Book

A guide for installing various technologies needed prior to coding the exercises in this book.

Setting Up The Development Environment

We'll look at what you'll learn throughout Fullstack Web Components.

Module 1 Summary

Introduction

In Part 1, you'll code a form using several Web Components specifications.

Specification

Part One

By developing the CardComponent, you'll get hands on experience with autonomous custom elements.

Autonomous custom elements

Before you can develop the CardComponent, you'll need to scaffold the component in Storybook.

Template Slots

Shadow DOM provides encapsulation for styling and template. You'll style CardComponent with CSS in the context of the autonomous custom element's Shadow DOM.

Styling CardComponent

Write integration and snapshot tests for CardComponent using Cypress and Storybook Storyshots.

Testing the card

You built an autonomous custom element with Shadow DOM, HTML templates, and ES Modules. Let's reflect on that.

Chapter One Summary

Getting to Know Web Components

Form-associated custom elements allow custom elements to participate in HTML forms. From validation to submission, you'll code a text input end-to-end.

Form-associated custom elements

Scaffold a form-associated custom element named TextInputComponent in Storybook.

TextInputComponent

You'll learn what distinguises a form-associated custom element from an autonomous custom element, the formAssociated property and ElementInternals interface.

Form Associated and ElementInternals

Form-associated custom elements don't come with a pattern that validates an entire form, so you'll implement a pattern that allows form validation.

Handling Validation

Using observedAttributes and attributeChangedCallback to listen and react to changes in custom element attributes.

Listening for attribute changes

You'll style the various interaction states of the TextInputComponent form-associated custom element.

User feedback

We've created a problem by encapsulating the HTMLInputElement by Shadow DOM. The HTMLInputElement API cann't be accessed by the outside world. In this section, you'll fix that by implementing getters and setters that emulate the HTMLInputElement on TextInputComponent.

Emulating HTMLInputElement

You'll update the Story and provide the missing APIs to TextInputComponent that allow the component to fully interact with a HTML form.

Making a form

Reviewing the work completed on the form-associated custom element TextInputComponent.

Chapter Two Summary

You'll code ButtonComponent, a customized built-in element that inherits accessibility characteristics from HTMLButtonElement.

Customized built-in elements

Scaffold the customized built-in element ButtonComponent with Storybook.

Scaffolding ButtonComponent

Customized built-ins can't benefit from the encapsulation provided by Shadow DOM, so you'll have to find another way to style ButtonComponent.

Styling ButtonComponent

Revist the HTML form by making the user experience more accessible.

Making the form accessible

How customized built-in elements can make custom elements more accessible.

Chapter Three Summary

You'll learn best practices for developing a UI Library with Web Components by coding a micro-library, developing two custom elements with the micro-library, and figuring out how to package the UI library for distribution.

UI Library

Part Two

You'll abstract common patterns intro reusable code in a micro-library powered by TypeScript Decorators.

Micro-library

How to code an interface for Web Components with TypeScript decorators that enables declaration of the selector, styles, and template.

Class Decorator

You'll code a method decorator named Listen that binds event listeners to class methods.

Method Decorator

In this chapter you learned how to code a micro-library with TypeScript decorators that streamlines Web Component development.

Chapter Four Summary

You'll investigate multiple methods for components to communicate by coding an editable table.

Component Communication

How to use mock data in Storybook to code Web Components.

Mocking Table Data in Storybook

You'll learn about three methods for custom elements to communicate, attribute drilling, CustomEvent, and BroadcastChannel.

Coding Compound Components

You'll learn about how to create a separation of concerns between the many custom elements that comprise the editable table.

Making the Table Editable

You learned about how to create a separation of concerns between various custom elements in the same user experience flow.

Summary

Compound Custom Elements

You'll learn how to code a common UX pattern (dialogs) using HTML templates and custom elements.

HTML Templates

You'll mock the DialogComponent in Storybook.

Mocking the Dialog in Storybook

You'll make a configurable dialog with custom elements.

DialogComponent

You'll scaffold two custom elements that leverage DialogComponent to display modals and tooltips.

Modal and Tooltip

You'll fix an issue faced in the last section by learning how to query for elements across Shadow boundaries.

Querying DOM Across Shadow Boundaries

You'll control the ordering and event cycle of dialogs with a custom class named DialogStack.

DialogStack

Summarizing the work completed in DialogComponent, ModalComponent, TooltipComponent, and DialogStack.

Chapter Six Summary

Powering Dialogs with HTML Templates

You'll learn best practices for organizing and distributing Web Component UI libraries.

UI Libraries

You'll learn brest practices for distributing Web Components by formatting the code with named exports, configuring the build with Rollup, providing a standard package format, and writing a custom Node.js script that enables you to publish packages.

Distribution

Custom Elements Manifest provides a wealth of information about each component. After generating a manifest, it will provide documentation for each component in Storybook.

Documentation

You'll learn how to setup continuous integration for the UI library with Github Actions.

Continuous Integration

Let's reflect on the best practices you learned for distributing UI libraries filled with Web Components.

Chapter Seven Summary

Distributing Custom Element Libraries

You'll integrate the UI library with a single-page application and code the end-to-end user experience with custom elements.

Application

Part Three

You'll provide a separation of concerns with custom elements in a single page application.

Application Development with Custom Elements

You'll scaffold the landing page with an autonomous custom element named MainView.

Landing Page

You'll code a global header with autonomous custom elements named AppHeader.

Header

You'll code another autonomous custom element that handles cookie authorization named CookieFooter.

CookieFooter

You'll lazyload an image with customized built-ins.

Background

You developed the landing page of the application, learning how to architect a separation of concerns between the UI components.

Chapter Eight Summary

To handle multiple views in the single page application, you'll need to implement a router that can navigate between each view.

Routing Custom Elements in a SPA

You'll code the Router class that handles the creation and removal of views in the application.

Routing

You'll code the necessary components and services required in the login view.

Login View

Integrate TableCardComponent into a third view of the single page application, the dashboard.

Dashboard View

You coded a single page web application with custom elements and a custom router.

Chapter Nine Summary

You'll server-side render the views of the application with Declarative Shadow DOM and @lit-labs/ssr

Server-Side Rendering Custom Elements

You'll declare a server-side renderable Declarative Shadow DOM HTML template for each component.

Declarative Shadow DOM Templates

To get custom elements to work in Node.js, you'll need to polyfill DOM APIs. Luckily, @lit-labs/ssr provides a tool that enables just that.

Shim

You'll develop Express middleware that server-side renders Declarative Shadow DOM HTML Templates with @lit-labs/ssr.

Express Middleware

You rendered custom elements server-side using Declarative Shadow DOM and @lit-labs/ssr.

Chapter Ten Summary

Server-side Rendering with Declarative Shadow DOM

The conclusion of the book Fullstack Custom Elements.

Conclusion

Fullstack Web Components

Enter your name and email address below, then click the **"Send my free chapter"** button to get started

There are several books about Web Components, but none go into how to integrate Web Components in a typical enterprise web development workflow. This book is designed to help you learn Web Components and integrate it into your work.

In this book, we cover the basics of Web Components, how to code complex user interfaces with custom elements in Storybook, how to test and maintain UI libraries built with custom elements, and how to build web applications entirely with Web Components and browser specifications. It comes with complete code examples. We walk through the entire process step-by-step.

It's taught by Stephen Belovarich, a software engineer and web developer. Stephen has provided what he's learned about UI libraries and web applications while working at Ubiquiti Networks, Norton, Nike, NBC Universal, and Workday, that can benefit other developers, students, and anyone making a website.

The Complete Guide to Building UI Libraries with Web Components

In this book, we will learn Web Components through the lens of a JavaScript developer.

The basics of working with and manipulating Web Components

The best practices for maintaining a UI library made of custom elements

How to create a micro-library for Web Components with TypeScript Decorators

What problems Web Components can solve in everyday development

How to build web applications entirely from Web Components and JavaScript

, you stored the state of a single dialog, but haven't yet found a way to orchestrate the rendering of several dialogs at once. You also haven't handled the "closed" state of a dialog, which is what happens when the user closes the dialog either by pressing the "Escape" key, the close button where available, or by clicking outside of the dialog.

Several problems could arise from the current implementation if we were to attempt to handle all these use cases. Nothing is currently tracking if a dialog is focused. If we add event listeners to each dialog we could end up with many different event listeners which could hurt performance, however unlikely given the number of dialogs in the current implementation. Perhaps it would be a good idea to delegate the focus event listener to a single place that also tracks the currently focused dialog.

 could also cause issues. We'd have to rely on the order of the elements in DOM which means a lot of DOM manipulation each time the order of dialogs changes. Suppose the user clicks on another dialog in the background. The user would expect that dialog to come to the front. In order to do that currently, we'd need to change the order of DOM nodes appended to the 

. Nothing can handle a change like that yet, but perhaps a more performant solution would be to set the 

 of each dialog in a well defined range of 

To orchestrate the rendering of several dialogs, let's introduce a new 

 is instantiated and changes state, the component should update 

 would be a singleton and requires global scope to operate. For the purposes of this exercise, we'll instantiate 

 in the same directory where you've been working on all the dialogs.

touch packages/component/src/dialog/DialogStack.ts

 is supposed to store template ids and the order of dialogs rendered in the view.

export class DialogStack {
  stack: Element[] = [];
  templateId: string[] = [];
  constructor() {}
}

Let's first handle the registration and removal of template ids. Add a method named 

 that will eventually be called from the context of 

registerTemplate(id: string) {
    if (!this.templateId.find((templateId) => templateId === id)) {
        this.templateId.push(id);
    }
}

Declare another method that finds the index of an 

findTemplateIndex(id: string) {
    return this.templateId.findIndex((templateId) => templateId === id);
}

 if it exists. This has the effect of removing the 

removeTemplate(id: string) {
    const templateIndex = this.findTemplateIndex(id);
    if (templateIndex) {
        this.templateId.splice(templateIndex, 1);
    }
}

 state covered, let's turn our attention to managing the 

 yet, but supposing we did, the dialog at the last 

 would be the dialog that should be layered on top of every other. Set a 

setZIndices() {
    const base = 9000;
    this.stack.forEach((element, index) => {
        (element as HTMLElement).style.zIndex = (base + index * 10).toString();
    });
}

Make another method that adds a dialog to the 

 to keep it generic, but it might as well be 

 currently handles rendering the dialog, but in a member you'll deprecate that functionality from 

 because it makes a lot more sense to add the call to 

 here. After the dialog is appended to the 

pushDialog(element: Element) {
    this.stack.push(element);
    document.body.appendChild(element);
    this.setZIndices();
}

Integrate DialogStack with DialogComponent

import { DialogStack } from "./DialogStack";

 should be global, so we'll store it on the 

declare global {
  interface Window {
    __dialogStack: DialogStack;
  }
}

 so it can be used in the context of the story. You should also export the 

---
title: DialogStack
description: You'll control the ordering and event cycle of dialogs with a custom class named DialogStack.
isPublicLesson: true
---

## DialogStack

In `DialogComponent`, you stored the state of a single dialog, but haven't yet found a way to orchestrate the rendering of several dialogs at once. You also haven't handled the "closed" state of a dialog, which is what happens when the user closes the dialog either by pressing the "Escape" key, the close button where available, or by clicking outside of the dialog.

Several problems could arise from the current implementation if we were to attempt to handle all these use cases. Nothing is currently tracking if a dialog is focused. If we add event listeners to each dialog we could end up with many different event listeners which could hurt performance, however unlikely given the number of dialogs in the current implementation. Perhaps it would be a good idea to delegate the focus event listener to a single place that also tracks the currently focused dialog.

Having all dialogs on the same `z-index` could also cause issues. We'd have to rely on the order of the elements in DOM which means a lot of DOM manipulation each time the order of dialogs changes. Suppose the user clicks on another dialog in the background. The user would expect that dialog to come to the front. In order to do that currently, we'd need to change the order of DOM nodes appended to the `document.body`. Nothing can handle a change like that yet, but perhaps a more performant solution would be to set the `z-index` of each dialog in a well defined range of `z-index` reserved only for dialogs: 9000-9999.

To orchestrate the rendering of several dialogs, let's introduce a new `class` named `DialogStack`. The responsibility of `DialogStack` will be the following:

-   Store order of dialogs rendered in the view
-   Store template ids
-   Store the currently focused dialog
-   Store the previously focused dialog
-   Delegate focus events for each dialog

`DialogStack` will require some integration with `DialogComponent`. When `DialogComponent` is instantiated and changes state, the component should update `DialogStack`. `DialogStack` would be a singleton and requires global scope to operate. For the purposes of this exercise, we'll instantiate `DialogStack` on the `window` so it's accessible globally.

To begin development on `DialogStack`, make a new file named `DialogStack.ts` in the same directory where you've been working on all the dialogs.

### DialogStack

```bash
touch packages/component/src/dialog/DialogStack.ts
```

In `DialogStack.ts` export a new `class` named `DialogStack` and declare a `constructor`. Add two properties (`stack` and `templateId`) we know are required if `DialogStack` is supposed to store template ids and the order of dialogs rendered in the view.

```typescript
export class DialogStack {
  stack: Element[] = [];
  templateId: string[] = [];
  constructor() {}
}
```

Let's first handle the registration and removal of template ids. Add a method named `registerTemplate` that will eventually be called from the context of `DialogComponent`. The only argument for the new `method` is a `string` named `id`. If the `id` is not found in the `templateId Array`, add the `id` to the `Array`.

```typescript
registerTemplate(id: string) {
    if (!this.templateId.find((templateId) => templateId === id)) {
        this.templateId.push(id);
    }
}
```

Declare another method that finds the index of an `id` in the `templateId Array`. You'll need this `index` to remove an `id` from the `Array`.

```typescript
findTemplateIndex(id: string) {
    return this.templateId.findIndex((templateId) => templateId === id);
}
```

Make a method on the `DialogStack class` named `removeTemplate`. Using the only argument `id`, call `findTemplateIndex`. Splice the `templateId` at the `index` of the `id` if it exists. This has the effect of removing the `id` from the `Array`.

```typescript
removeTemplate(id: string) {
    const templateIndex = this.findTemplateIndex(id);
    if (templateIndex) {
        this.templateId.splice(templateIndex, 1);
    }
}
```

With `templateId` state covered, let's turn our attention to managing the `z-index` of each dialog in the `stack Array`. We haven't populated the `Array` yet, but supposing we did, the dialog at the last `index` in the `Array` would be the dialog that should be layered on top of every other. Set a `const` named `base` to `9000`, the first (and lowest) `z-index`. Iterate through the `stack` with `forEach`, setting the `zIndex` of each dialog, incrementing the `z-index` by the `index` of the dialog in the `Array`.

```typescript
setZIndices() {
    const base = 9000;
    this.stack.forEach((element, index) => {
        (element as HTMLElement).style.zIndex = (base + index * 10).toString();
    });
}
```

Make another method that adds a dialog to the `stack Array`. The argument for this method is typed `Element` to keep it generic, but it might as well be `ModalComponent | TooltipComponent`. Call `push` on the `Array.prototype` to add the dialog to the `stack Array`. `DialogComponent` currently handles rendering the dialog, but in a member you'll deprecate that functionality from `DialogComponent` because it makes a lot more sense to add the call to `appendChild` here. After the dialog is appended to the `document.body`, call `setZIndices`.