Working With My First Web Component

As a technology, web components have been on my radar for quite some time. From what I can see, the first or one of the first mentions of this was way back in 2011 over a decade ago. In that time, virtually every browser came around to supporting them (except for one holdout for a of the specification, and you get one guess as to who the holdout is), so over the weekend, I took a quick look at the technology to see how hard it would be to build a simple demo. I've got to say I was rather surprised. I've only scratched the surface of the technology, and I've got a good idea for a follow-up post, but I thought I'd quickly share the simple example I built and my thoughts on working with the tech in general. part What exactly is it? At a high level, a web component lets you define a custom HTML element. So for example, I could do this: My Cats

The definition of comes externally and can consist of any regular HTML blocks. So the result of the above could be: pet-cat practical My Cats

Luna This cat is 11 years old.

Elise This cat is 12 years old.

Pig This cat is 9 years old.

These elements act just like regular HTML tags. You can even use JavaScript to create new instances of them and dynamically change their attributes. I highly suggest reading the MDN for Web Components as it goes into great detail, but the main building blocks consist of: reference The ability to define a custom element ( above) in JavaScript pet-cat The Shadow DOM, which sounds really cool but is basically a way of saying a document tree that is encapsulated inside itself and away from the rest of your document. I saw a great example of this and can't remember the source, but think of the tag and how it has built-in controls for working with videos. That's a DOM that's encapsulated within itself. And finally, HTML templates that are not rendered but used by the web component for layout. I actually did touch this aspect for the demo I built, so it's not 100% necessary. not Web components come in two main flavors: Completely unique ones like the example I gave above. Components that modify existing tags, recognized via the syntax: . This is where we hit the issue with that one particular browser. Safari does not support this style, and as far as I know, never will. Who knows. To be honest, I find this style less appealing then the previous one so it doesn't bother me too much. as Ok, but why? Right away I can see that web components would be a great boon to UI libraries. I checked, and while Bootstrap doesn't support it, it's on their radar. Having used , I can tell you the experience of using Bootstrap with components is better than "regular" Bootstrap. As an example, here's a simple tabbed UI: BootstrapVue significantly First Second Disabled While not difficult, compare it to this: I'm the first tab

I'm the second tab

I'm a disabled tab!

I can also see this being really useful inside an organization where consistent UI/UX/etc elements need to be built across a large site. Using web components would certainly make that simpler. With what I said above, I don't necessarily think it's going to be something every developer uses on every little project, but that's ok. We've seen other JavaScript improvements that are more useful to library developers than day-to-day development. How about an example? Give me the kitty... For my first test, I built a quick wrapper for . I created a file, , and defined it as such: PlaceKitten cat.js class PlaceCat extends HTMLElement {

constructor() {

super();

const shadow = this.attachShadow({ mode: 'open' }); const wrapper = document.createElement('div');

let width = 500; let height = 500;

if(this.hasAttribute('width')) width = this.getAttribute('width'); if(this.hasAttribute('height')) height = this.getAttribute('height');

const img = document.createElement('img'); img.setAttribute('src', `https://placekitten.com/${width}/${height}`); wrapper.appendChild(img);

shadow.appendChild(wrapper);

}

customElements.define('place-cat', PlaceCat); I've got a class that extends a base . It must have a constructor that calls . That variable there defines an 'open' interface which means the parent could "reach" into the DOM if necessary. HTMLElement super shadow Next, I have the logic for the component. Define a default width and height and override it if specified by the user. My DOM is a div tag with an image inside. When I'm done building it, I add it to my shadow I'm done. At the end, make note of the call. Web components be kabab-case, ie . define must something dash something In an HTML template, I just include it and use it:

Here's the result: Surely the web gods intended components to be used for cats, right? If you open up devtools, you can see them just as any other element: If you want, you can view it online here: https://cfjedimaster.github.io/webdemos/webcomponents/test1.html So that initial example was so trivial that it wouldn't work really well in a production environment. Specifically, it would fail in one respect. If I used JavaScript to make a new instance of the element and then set the dimensions, it would fail: let cat = document.createElement('place-cat'); cat.setAttribute('width', 200); cat.setAttribute('height', 400);

document.querySelector('body').appendChild(cat); Why? Because a web component has to define what attributes it will "listen" to for changes, and has to have custom logic of some sort to implement those changes. Luckily this can be done two methods. First, we define the attributes we want to watch: static get observedAttributes() { return ['width','height']; } And then we can use to handle those changes. It looks like so: attributeCHangedCallback attributeChangedCallback(name, oldValue, newValue) { // name is the attribute changing // old and new value represent the previous and new settings } I updated my cat element to make use of this: class PlaceCat extends HTMLElement {

getURL() { return `https://placekitten.com/${this.width}/${this.height}` }

constructor() {

super();

const shadow = this.attachShadow({ mode: 'open' }); const wrapper = document.createElement('div');

this.width = 500; this.height = 500;

if(this.hasAttribute('width')) this.width = this.getAttribute('width'); if(this.hasAttribute('height')) this.height = this.getAttribute('height');

const img = document.createElement('img'); img.setAttribute('src', this.getURL()); wrapper.appendChild(img);

shadow.appendChild(wrapper);

}

static get observedAttributes() { return ['width','height']; }

attributeChangedCallback(name, oldValue, newValue) { this[name] = newValue; this.shadowRoot.querySelector('img').src = this.getURL(); }

}

// Define the new element customElements.define('place-cat', PlaceCat); Note that I abstracted out the logic to get the image source in a function, . I can then use that in the constructor as well the callback for changes. Here's a pretty lame demo that has a button to make cats. I need one of these in real life: getURL

Make Cat

document.addEventListener('DOMContentLoaded', () => { document.querySelector('#makeCat').addEventListener('click', () => {

let cat = document.createElement('place-cat'); cat.setAttribute('width', 200); cat.setAttribute('height', 400);

document.querySelector('body').appendChild(cat);

}, false); }, false); Note I switched to in the script tag so I could keep my initial and 'advanced' cat component around. All I've done here is add a click handler to the button and then add the element to the body. If you want to try this yourself, take a gander here: cat2.js place-cat https://cfjedimaster.github.io/webdemos/webcomponents/test1a.html I wasn't planning on building a CodePen, and I didn't expect it to work, but I went ahead anyway: not https://codepen.io/cfjedimaster/pen/GRQmRxG?embedable=true More to Come I've only just begun to look at this but I definitely want to dig more. There's multiple projects out there that aim to make working with web components easier (I plan on looking at and ) but as always, I'd love to hear from folks using this in the wild. Let me know if you've implemented them in your work and what you think. Lit Stencil Also published . here

Working With My First Web Component

Too Long; Didn't Read

Companies Mentioned

Coin Mentioned

@raymondcamden

RELATED STORIES