• Slots Shadow Domain
• Slots Without Shadow Dom

Many types of components, such as tabs, menus, image galleries, and so on, need the content to render.

Just like built-in browser <select> expects <option> items, our <custom-tabs> may expect the actual tab content to be passed. And a <custom-menu> may expect menu items.

The code that makes use of <custom-menu> can look like this:

…Then our component should render it properly, as a nice menu with given title and items, handle menu events, etc.

Shadow DOM fixes this by giving us: Isolated DOM tree: The shadow DOM is self-contained and the outside cannot query elements on the inside (e.g. Document.querySelector wont return nodes from within the shadow tree) Scoped CSS: Styles defined within the shadow DOM will not leak out, and outside styles will not bleed in. By default, if an element has shadow DOM, the shadow tree is rendered instead of the element's children. To allow children to render, you can add a slot element to your shadow tree. Think of the slot as a placeholder showing where child nodes will render. Consider the following shadow tree for.

How to implement it?

We could try to analyze the element content and dynamically copy-rearrange DOM nodes. That’s possible, but if we’re moving elements to shadow DOM, then CSS styles from the document do not apply in there, so the visual styling may be lost. Also that requires some coding.

Luckily, we don’t have to. Shadow DOM supports <slot> elements, that are automatically filled by the content from light DOM.

Named slots

Let’s see how slots work on a simple example.

Here, <user-card> shadow DOM provides two slots, filled from light DOM:

In the shadow DOM, <slot name='X'> defines an “insertion point”, a place where elements with slot='X' are rendered.

Then the browser performs “composition”: it takes elements from the light DOM and renders them in corresponding slots of the shadow DOM. At the end, we have exactly what we want – a generic component that can be filled with data.

Here’s the DOM structure after the script, not taking composition into account:

There’s nothing odd here. We created the shadow DOM, so here it is. Now the element has both light and shadow DOM.

For rendering purposes, for each <slot name='...'> in shadow DOM, the browser looks for slot='...' with the same name in the light DOM. These elements are rendered inside the slots:

The result is called “flattened” DOM:

…But the “flattened” DOM is only created for rendering and event-handling purposes. That’s how things are shown. The nodes are actually not moved around!

That can be easily checked if we run querySelector: nodes are still at their places.

It may look bizarre, but for shadow DOM with slots we have one more “DOM level”, the “flattened” DOM – result of slot insertion. The browser renders it and uses for style inheritance, event propagation. But JavaScript still sees the document “as is”, before flattening.

The slot='...' attribute is only valid for direct children of the shadow host (in our example, <user-card> element). For nested elements it’s ignored.

For example, the second <span> here is ignored (as it’s not a top-level child of <user-card>):

In practice, there’s no sense in slotting a deeply nested element, so this limitation just ensures the correct DOM structure.

Slot fallback content

If we put something inside a <slot>, it becomes the fallback content. The browser shows it if there’s no corresponding filler in light DOM.

For example, in this piece of shadow DOM, Anonymous renders if there’s no slot='username' in light DOM.

Default slot

The first <slot> in shadow DOM that doesn’t have a name is a “default” slot. It gets all nodes from the light DOM that aren’t slotted elsewhere.

For example, let’s add the default slot to our <user-card> that collects any unslotted information about the user:

All the unslotted light DOM content gets into the “Other information” fieldset.

Elements are appended to a slot one after another, so both unslotted pieces of information are in the default slot together.

The flattened DOM looks like this:

Menu example

Now let’s back to <custom-menu>, mentioned at the beginning of the chapter.

We can use slots to distribute elements.

Here’s the markup for <custom-menu>:

The shadow DOM template with proper slots:

1. <span slot='title'> goes into <slot name='title'>.
2. There are many <li slot='item'> in the template, but only one <slot name='item'> in the template. That’s perfectly normal. All elements with slot='item' get appended to <slot name='item'> one after another, thus forming the list.

The flattened DOM becomes:

One might notice that, in a valid DOM, <li> must be a direct child of <ul>. But that’s flattened DOM, it describes how the component is rendered, such thing happens naturally here.

We just need to add a click handler to open/close the list, and the <custom-menu> is ready:

Slots Shadow Domain

Here’s the full demo:

Of course, we can add more functionality to it: events, methods and so on.

Monitoring slots

What if the outer code wants to add/remove menu items dynamically?

The browser monitors slots and updates the rendering if slotted elements are added/removed.

Also, as light DOM nodes are not copied, but just rendered in slots, the changes inside them immediately become visible.

So we don’t have to do anything to update rendering. But if the component wants to know about slot changes, then slotchange event is available.

For example, here the menu item is inserted dynamically after 1 second, and the title changes after 2 seconds:

The menu rendering updates each time without our intervention.

There are two slotchange events here:

1. At initialization:

   slotchange: title triggers immediately, as the slot='title' from the light DOM gets into the corresponding slot.

2. After 1 second:

   slotchange: item triggers, when a new <li slot='item'> is added.

Please note: there’s no slotchange event after 2 seconds, when the content of slot='title' is modified. That’s because there’s no slot change. We modify the content inside the slotted element, that’s another thing.

If we’d like to track internal modifications of light DOM from JavaScript, that’s also possible using a more generic mechanism: MutationObserver.

Slot API

Finally, let’s mention the slot-related JavaScript methods.

As we’ve seen before, JavaScript looks at the “real” DOM, without flattening. But, if the shadow tree has {mode: 'open'}, then we can figure out which elements assigned to a slot and, vise-versa, the slot by the element inside it:

• node.assignedSlot – returns the <slot> element that the node is assigned to.
• slot.assignedNodes({flatten: true/false}) – DOM nodes, assigned to the slot. The flatten option is false by default. If explicitly set to true, then it looks more deeply into the flattened DOM, returning nested slots in case of nested components and the fallback content if no node assigned.
• slot.assignedElements({flatten: true/false}) – DOM elements, assigned to the slot (same as above, but only element nodes).

These methods are useful when we need not just show the slotted content, but also track it in JavaScript.

For example, if <custom-menu> component wants to know, what it shows, then it could track slotchange and get the items from slot.assignedElements:

Summary

Slots allow to show light DOM children in shadow DOM.

There are two kinds of slots:

• Named slots: <slot name='X'>...</slot> – gets light children with slot='X'.
• Default slot: the first <slot> without a name (subsequent unnamed slots are ignored) – gets unslotted light children.
• If there are many elements for the same slot – they are appended one after another.
• The content of <slot> element is used as a fallback. It’s shown if there are no light children for the slot.

The process of rendering slotted elements inside their slots is called “composition”. The result is called a “flattened DOM”.

Composition does not really move nodes, from JavaScript point of view the DOM is still same.

JavaScript can access slots using methods:

• slot.assignedNodes/Elements() – returns nodes/elements inside the slot.
• node.assignedSlot – the reverse meethod, returns slot by a node.

If we’d like to know what we’re showing, we can track slot contents using:

• slotchange event – triggers the first time a slot is filled, and on any add/remove/replace operation of the slotted element, but not its children. The slot is event.target.
• MutationObserver to go deeper into slot content, watch changes inside it.

Slots Without Shadow Dom

Now, as we have elements from light DOM in the shadow DOM, let’s see how to style them properly. The basic rule is that shadow elements are styled inside, and light elements – outside, but there are notable exceptions.

We’ll see the details in the next chapter.