Line-by-Line breakdowns go into excessive – and sometimes unnecessary – detail about a specific, small project. Be prepared for minutiae.
Here, I'll go through the FlatCube web component line-by-line. It is a single web component that draws a flattened-out representation of a Rubik's Cube (or other 3x3 twisty puzzle) based on a string passed in that describes the positions of the pieces. A cube contains six faces. A face contains nine pieces.
You'll probably want to have the full code open in another window to see this in context.
The component
Usage
<flat-cube facelet="UUUUUUUUURRRRRRRRRFFFFFFFFFDDDDDDDDDLLLLLLLLLBBBBBBBBB" />Line-by-line
First, all WebComponents must extend the HTMLElement class. If you're building with a library such as LitElement, you might extend a different class but that class will ultimately extend HTMLElement.
class FlatCube extends HTMLElement {The constructor is called every time a FlatCube element is created, not just once per page load.
constructor() {We have to call the constructor on HTMLElement so that all the behind-the-scenes plumbing is taken care of.
NOTE: If we don't do this, we can't use this.
super();Now set up some internal variables for the FlatCube itself. this.faces becomes an array representing the order of faces in the facelet string.
this.faces = 'URFDLB'.split('');
this.facelet = false;We attach the shadow DOM to this element so that we can access it easily during the render phase.
this._shadowRoot = this.attachShadow({ mode: 'open' });Then we create the template (see below) and trigger the first render to actually show the element on screen.
this.template = this.createTemplate();
this.render();
}Style
It isn't essential to separate the component's CSS into another method but I like to do it to keep everything nice and tidy.
style() {By using template literals, we can write a block of plain CSS.
return `The :host CSS selector references the element itself. It's kinda like this but in CSS.
NOTE: It can only be used from inside the Shadow DOM
:host {I want this component to be able to be used inline or as a block item so I'm specifying inline-block. If the context it ends up being used in requires it to be block, it's possible to wrap it in another element.
display: inline-block;Skinning and scaling
In this web component, one of the main goals of the implementation was the ability to easily change the size of the component and the colours of the faces.
Luckily, CSS variables make it super easy to make components skinnable and the calc function is very useful for scaling.
The base measurement
All the dimensions – the full component width, the faces, the individual pieces – are multiples of the --flat-cube-face-width value. This is passed in from the containing CSS by specifying a value for --flat-cube-face but if it is not specified, we want a fallback of 100px.
--flat-cube-face-width: var(--flat-cube-face, 100px);
}Now the styles for the complete element. Set position to be relative so that we can absolutely position the individual faces.
.flat-cube {
position: relative;And specify the element to be the height of 3 faces and the width of 4. This is where the calc function comes in handy, especially in a web component intended to be reusable and seamlessly scalable.
height: calc(3 * var(--flat-cube-face-width));
width: calc(4 * var(--flat-cube-face-width));I'm using outline rather than border for the lines between the pieces so I want to add a 1px margin around the outside to prevent clipping.
margin: 1px;
}Each individual face shares the same class
.face {Use the value passed in as the base measurement.
height: var(--flat-cube-face-width);
width: var(--flat-cube-face-width);Each face is absolutely positioned inside the containing .flat-cube element.
position: absolute;But rather than specify exact positions for each individual piece in a face, we use flexbox to lay them out automatically. We draw the pieces in order then let them wrap onto the next line,
display: flex;
flex-wrap: wrap;I wanted to specify the width of each piece as a simple ⅓ of the face width. In order to do that, I used outline rather than border as border actually takes space in the element where outline doesn't.
outline: 1px solid var(--flat-cube-outer, black);
}
These are simply the top and left positions of the individual faces. We don't really need to go line-by-line here.
.U-face {
top: 0;
left: var(--flat-cube-face-width);
}
.L-face {
top: var(--flat-cube-face-width);
left: 0;
}
.F-face {
top: var(--flat-cube-face-width);
left: var(--flat-cube-face-width);
}
.R-face {
top: var(--flat-cube-face-width);
left: calc(2 * var(--flat-cube-face-width));
}
.B-face {
top: var(--flat-cube-face-width);
left: calc(3 * var(--flat-cube-face-width));
}
.D-face {
top: calc(2 * var(--flat-cube-face-width));
left: var(--flat-cube-face-width);
}
Using the child selector to access the pieces inside the face.
.face > div {As I mentioned above, we want to calculate the width of the pieces simply as ⅓ of a face so we use outline. The alternative would be to calculate the pieces as (⅓ of (the face width minus 2 * the internal border width)). That sounds mistake-prone.
width: calc(var(--flat-cube-face-width)/3);
height: calc(var(--flat-cube-face-width)/3);
outline: 1px solid var(--flat-cube-inner, black);
}Again, this is just colours. We don't need to go line-by-line. The only thing to note is that each piece has a fallback colour specified in case the containing application doesn't pass one in.
.U-piece {
background-color: var(--flat-cube-up, #ebed2b);
}
.L-piece {
background-color: var(--flat-cube-left, #ff6b16);
}
.F-piece {
background-color: var(--flat-cube-front, #6cfe3b);
}
.R-piece {
background-color: var(--flat-cube-right, #ec1d35);
}
.B-piece {
background-color: var(--flat-cube-back, #4db4d7);
}
.D-piece {
background-color: var(--flat-cube-down, #fffbf8);
}And finally, we close off our template literal and end the style method.
`;
}Template
Now we build up the actual DOM of the element. We've done a lot of styling so far but, technically, we've nothing to apply the styles to. For that, we're going to build up the structure of faces and pieces then attach the styles.
structure() {At this point, we have a couple of choices. We can either build this structure once and update it or build it fresh every time we need to make a change. The latter is easier to write but the former has better performance. So let's do that.
This is the createTemplate method we called in the constructor. It is called only once for each instance of the component so we don't need to go through the whole building process every time.
createTemplate() {First, create a new template. Templates are designed for exactly this case – building a structure once and reuse it several times.
const template = document.createElement('template');Then we attach the styles we defined earlier:
template.innerHTML = `<style>${this.style()}</style>`;And, finally, actually create the first element that actually appears in the component. This is the div that contains everything. We also add the .flat-cube class to it.
const cubeElement = document.createElement('div');
cubeElement.classList.add('flat-cube');The this.faces array we defined in the constructor comes back here. We loop over each face we require and create the DOM for it.
this.faces.forEach((face, i) => {A div to contain the face with the shared .face class for the size and the specific class for the position and colour – .U-face, .B-face, etc.
const faceElement = document.createElement('div');
faceElement.classList.add('face');
faceElement.classList.add(`${face}-face`);Now we create the individual pieces. If we wanted to make this component customisable so that it could represent cubes with a different number of pieces(2x2, 4x4, 17x17, etc.), we'd use a variable here instead of 9.
for (let j=0; j < 9; j++) {Now we call out to the preparePiece method (see below) without an element to make sure the piece has the right class assigned to it before we append the piece to the face.
faceElement.appendChild(this.preparePiece(i, j));
}By the time we get here, we have a face div with 9 piece divs appended. Now we can add that to the cube.
cubeElement.appendChild(faceElement);
});Do that for each face and we have a div containing a completed flat-cube which we can append to the template.
template.content.appendChild(cubeElement);And return the template to the constructor.
return template;
}Updating
Now we have the structure in a template, we can grab a copy of it any time we need to update the cube.
updateTemplate() {Passing true to cloneNode means we get a deep clone (containing all the nested faces and pieces) rather than a shallow clone (just the top-level element).
const update = this.template.content.cloneNode(true);We loop over each face and then each piece (div) in each face to update it.
update.querySelectorAll('.face').forEach((face, i) => {
face.querySelectorAll('div').forEach((piece, j) => {We're using the same method here as we did to create the individual pieces (code reuse is A Good Thing) but this time we're passing in the piece we already have rather than asking the method to create a new one.
this.preparePiece(i, j, piece);The update variable now contains an updated DOM representing the current facelet string.
});
});
return update;
}This method takes the i (index of the face) and j (index of the piece) we need to figure out which colour this piece needs to be. It also takes an optional argument of piece. If we don't provide that – the way we do in the initial createTemplate call – piece will be a newly created div. If we do provide that argument, we'll update whatever is passed in instead.
preparePiece(i, j, piece = document.createElement('div')) {We have to map the facelet string – default: "UUUUUUUUU...etc" – into the two-dimensional structure of faces and pieces. Okay, technically, it's a one-dimensional mapping of a two-dimensional mapping of a three-dimensional structure. But... let's just not.
const start = (i * 9) + j;
const end = (i * 9) + j + 1;
This means "If we don't have a facelet string, just colour the piece according to what face it is in, otherwise, colour it according to the i,j position in the facelet string".
piece.className = !this.facelet ? `${this.faces[i]}-piece` : `${this.facelet.slice(start, end)}-piece`;Once we've updated the piece, return it so it can be included in the content.
return piece;
}We call this method in the constructor and every time we want to update.
render() {Empty out the element content
this._shadowRoot.innerHTML = '';And replace it immediately with the content we generate with the update method from above.
this._shadowRoot.appendChild(this.updateTemplate());
}This is how we register the component to listen for changes. This getter returns an array listing the attributes we want to listen for.
static get observedAttributes() {There's only one attribute we care about listening to. Any change to the facelet attribute will cause us to re-render.
return ['facelet'];
}The other part of registering for changes to the attributes. This is the handler that is invoked with the name of the changed attribute (useful when you're listening to a lot of attributes), the oldValue (before the change) and the newValue (after the change).
attributeChangedCallback(name, oldValue, newValue) {We only care about the newValue because we've only registered a single listener and we don't need the oldValue.
this.facelet = newValue;Then we trigger a new render to update the state of the element.
this.render();
}And we close out our FlatCube class.
}Listening for events
The final part of the puzzle is to register our new element with the browser so that it knows what to do when it sees our element. We do this by passing our new element to the CustomElementRegistry.
I like to check if my element has already been registered. Without this, including the script twice by accident will trigger an error that the user of the component isn't necessarily going to recognise.
if (!window.customElements.get('flat-cube')) {To register, you pass the tag name you want to use and the element class.
NOTE: tag names for custom components must contain a hyphen.
customElements.define('flat-cube', FlatCube);
}And that's it. Every line looked at and, hopefully, explained.
Let me know what you would have done differently or if there are any (ideally small) projects you'd like me to look at line-by-line.
