Reactにできないことがある — Web Components

Web Components。ブラウザと枠で区切られた再利用可能なUI部品。

Reactを使わずに、ブラウザ標準の機能だけで部品を作れます。Custom Elementsを試し、Reactと組み合わせるときの注意点まで見ます。

roadmap.sh のどこをやっているか

Frontend›Web Components
  • Custom Elements / Shadow DOM / HTML Templates
  • ブラウザ標準の部品(フレームワークを使わない選択肢)

この記事は、上の項目を実際に手を動かして確かめる回です。

前回: 絞り込み付き一覧を自力で作る — useStateをいくつ持つか 作業はVMの中(Ubuntu)、確認はホストのWindowsのブラウザです。今回は npm を一度も使いません。 DOM操作の回で作った ~/web/ をそのまま使います。

コンポーネントの回で、こういうものを書きました。

function TaskCard({ title, done }) {
  return <div className="card">{title}</div>;
}

「見た目と、その見た目が使うデータを、ひとまとまりの部品にする」という考え方です。これを覚えたあと、多くの人がこう思い込みます。

コンポーネントというのは、React(やVue)が持ち込んだ新しい書き方だ

違います。 ブラウザ自身に、同じことをするための標準機能があります。Web Components と呼ばれるものです。React より前から仕様が存在し、いまはどのブラウザでも動きます。

そして重要なのは順番です。この記事は、Reactを先にやったからこそ書けます。

  • Reactを知らずにWeb Componentsを読むと、「ただの長いJavaScript」にしか見えません。 何がうれしいのか分からない
  • Reactを知ってから読むと、「Reactがやっていたことの、どこがブラウザ側にあって、どこが無いのか」が線で見えます

さらにこの記事には、Reactに対する明確な勝ち筋が1つあります。

Shadow DOM を使うと、部品の中に書いたCSSが外に漏れず、外のCSSも中に効きません。 これは React には無い機能です。 React の className は、ただのクラス名です。

その代わり、負けている点もはっきりしています。 最後にそこも正直に書きます。結論から言うと、このサイトは引き続き React で進めます。

対象レベル: 初級 / 区分: 必要に応じて読む

目次

この記事でわかること

  • 「コンポーネント」はReactの発明ではないこと。ブラウザ標準の仕組みが別にあること
  • カスタム要素の名前にハイフンが必須な理由(<mycard> は作れず <my-card> にしなければならない)
  • Shadow DOM が本当にCSSを遮断すること。それがReactにはできないこと
  • <template> の中身は「書いてあるのに動かない」こと。それが何の役に立つか
  • なぜ標準なのに主流にならなかったのか(状態管理が無い・書く量が多い・SSRと相性が悪い、の3つ)
  • どこで使い、どこで使わないか。アプリ全体をこれで作らない理由

この記事でやること

  1. Custom Elements だけを試す。class extends HTMLElement で <hello-badge> を作り、ハイフンを外してわざと失敗させる
  2. Shadow DOM だけを試す。外の p { color: red } が中に効かないことを、目で見て確かめる
  3. <template> と <slot> だけを試す。中身を外から差し込む
  4. 3つを1つの部品に組み合わせて、<info-card> を作る
  5. npm も Vite も使わずに動いていることを確認し、~/react-demo/ と手数を比べる

先に知る言葉

この記事で初めて出てくる言葉です。 基本的な言葉は用語集にもまとめてあります。

言葉意味
Web Componentsブラウザ標準の部品化の仕組み。特定の1機能ではなく、3つの機能の総称
Custom Elements自分でHTMLタグを増やせる仕組み。<my-card> のような独自のタグを定義する
Shadow DOM要素の中に作る隔離されたDOM。中と外でCSSが行き来しない。「影のDOM」
シャドウルート(shadow root)Shadow DOM の入口になる、中身を入れるための箱。attachShadow() で作る
ライトDOM(light DOM)Shadow DOM に対する普通のDOMのこと。いままで触ってきた側
<template>書いてあるが、そのままでは表示も実行もされないHTML。型紙として後から複製して使う
<slot>部品の中に開けておく穴。外から書いた中身が、その位置に差し込まれる
ライフサイクル部品が画面に置かれた・外された・属性が変わったといった節目。それぞれに呼ばれる関数がある
カプセル化中身を外から触れなくすること。Shadow DOM がCSSに対してやっているのがこれ

「Web Componentsをインストールする」ということはできません。 ライブラリではなく、ブラウザに最初から入っている3つの機能の呼び名だからです。 だから今回、npm install は1回も出てきません。


準備 — 素のHTMLに戻る

VMの中で、作業用のファイルを1枚だけ作ります。

bash
$ cd ~/web
$ touch wc.html

VS Code の Remote-SSH で繋いで、~/web/wc.html を編集してください。

配るのは、DOM操作の回と同じやり方です。

bash
$ sudo ufw allow 8000/tcp
$ cd ~/web
$ python3 -m http.server 8000 --bind 0.0.0.0

ホストのWindowsのブラウザから http://<VMのIPアドレス>:8000/wc.html を開きます。IPアドレスが分からなくなったら、別のターミナルで ip a です。

python3 -m http.server は開発用です。 nginxの回でやったような本番用のサーバーではありません。確認が終わったら Ctrl + C で止めます。


① Custom Elements だけを試す

まず1つ目だけ。 Shadow DOM も <template> も、まだ使いません。

~/web/wc.html を、これで丸ごと作ります。

<!DOCTYPE html>
<html lang="ja">
<head>
  <meta charset="UTF-8">
  <title>Web Components を試す</title>
</head>
<body>
  <h1>① Custom Elements</h1>

  <hello-badge name="世界"></hello-badge>
  <hello-badge name="Ubuntu"></hello-badge>

  <script>
    class HelloBadge extends HTMLElement {
      connectedCallback() {
        this.textContent = 'こんにちは、' + this.getAttribute('name') + ' さん';
      }
    }
    customElements.define('hello-badge', HelloBadge);
  </script>
</body>
</html>

リロードすると、2行出ます。

こんにちは、世界 さん
こんにちは、Ubuntu さん

ブラウザは <hello-badge> というタグを知りません。 それなのに動きました。customElements.define() で、ブラウザに「このタグはこう振る舞う」と教えたからです。

[スクリーンショット: 01_custom-element.png] ホストのブラウザで wc.html を開き、<hello-badge> が2行表示されている画面を撮ってください。

何が起きているのか

書いたもの意味
class HelloBadge extends HTMLElementHTMLの要素を継承する。<div> や <p> と同じ仲間になる
connectedCallback()この要素が画面に置かれたときにブラウザが呼ぶ関数
thisその要素そのもの。document.querySelector('hello-badge') で取れるのと同じもの
this.getAttribute('name')HTMLに書いた name="世界" を読む
customElements.define('hello-badge', HelloBadge)タグ名とクラスを結びつける登録

Reactとの対応を見ておきます。

ReactCustom Elements
関数コンポーネントHTMLElement を継承したクラス
props属性(attribute)。getAttribute() で読む
初回の描画connectedCallback()
useEffect の後片づけdisconnectedCallback()
再レンダリング無い(ここが後で効いてきます)

props にあたるものが「属性」だ、というのが最初の違いです。 DOM操作の回でやったとおり、HTMLの属性は必ず文字列です。React のように、オブジェクトや関数をそのまま渡すことはできません。

使える節目(ライフサイクル)

class Sample extends HTMLElement {
  constructor() {
    super();          // 必ず最初に呼ぶ
  }
  connectedCallback() {}       // 画面に置かれた
  disconnectedCallback() {}    // 画面から外された
  attributeChangedCallback(name, oldValue, newValue) {}  // 属性が変わった
  static get observedAttributes() { return ['name']; }   // ↑ を見張る属性
}

attributeChangedCallback は、observedAttributes に名前を書いた属性しか呼ばれません。 書き忘れると「属性を変えたのに何も起きない」になります。あとで踏みます。

名前にハイフンが必要

ここが1つ目の落とし穴です。 さっきの define を、こう変えてみてください。

customElements.define('hellobadge', HelloBadge);

エラーになります。 ブラウザの Console(開発者ツールの回の F12)を開くと出ます。

Uncaught SyntaxError: Failed to execute 'define' on 'CustomElementRegistry':
"hellobadge" is not a valid custom element name

カスタム要素の名前には、ハイフンを1つ以上入れなければいけません。 これは仕様で決まっています。

理由は「将来の衝突を防ぐため」です。

  • HTMLの標準タグには、ハイフンが入っているものが1つもありません。 div p section dialog search …
  • 標準タグは、これからも増えます。 実際 <dialog> も <search> も後から入りました
  • もし <tab> という部品を自作していて、将来ブラウザが本物の <tab> を実装したら、世界中のページが壊れます
  • 「ハイフン入りは自作、ハイフン無しは標準」と縄張りを分けてしまえば、永久に衝突しません

これは「仕様がうるさい」のではなく、後方互換のための取り決めです。 ブラウザは、20年前に書かれたページも壊さないという約束で動いています。名前空間を分けるのは、その約束を守るための最小限のコストです。

ついでに、ハイフンにはもう1つ効果があります。ブラウザはハイフン入りの未知のタグを見つけると、「これは将来定義されるかもしれない部品だ」と判断して、HTMLUnknownElement ではなく通常の HTMLElement として扱います。 JavaScript の読み込みが遅れても、要素そのものは先に存在できます。

戻しておいてください。

customElements.define('hello-badge', HelloBadge);

② Shadow DOM だけを試す —

ここが、この記事でいちばん大事なところです。 カスタム要素はいったん忘れて、Shadow DOM だけを試します。

~/web/wc.html の <body> を、こう書き換えます。

<body>
  <style>
    p { color: red; font-size: 20px; }
  </style>

  <h1>② Shadow DOM</h1>

  <p>これは外の p です。赤いはずです。</p>

  <div id="host"></div>

  <p>これも外の p です。赤いはずです。</p>

  <script>
    const host = document.querySelector('#host');
    const root = host.attachShadow({ mode: 'open' });
    root.innerHTML = `
      <style>
        p { color: blue; font-weight: bold; }
      </style>
      <p>これは Shadow DOM の中の p です。</p>
    `;
  </script>
</body>

リロードして、3つの p を見てください。

位置書いてあるCSS実際の色
1つ目(外)外の color: red赤
2つ目(Shadow DOM の中)中の color: blue青。赤くならない
3つ目(外)外の color: red赤。太字にならない

これが確認したかったことです。

  • 外の p { color: red } は、Shadow DOM の中の p に効きません(中は青のまま)
  • 中の p { font-weight: bold } は、外の p に漏れません(外は細字のまま)

[スクリーンショット: 02_shadow-dom-css.png] 3つの段落が「赤 / 青の太字 / 赤」で表示されている画面を撮ってください。中だけ色が違うことが分かる撮り方でお願いします。

本当に遮断されているのか、Consoleで確かめる

見た目だけだと「たまたま優先順位で勝っただけ」かもしれません。 F12 の Console で、これを打ってください。

document.querySelectorAll('p').length
2

3つ書いたのに、2しか返りません。 document.querySelectorAll から、Shadow DOM の中の p は見えていないのです。

中を見たいときは、シャドウルートを経由します。

document.querySelector('#host').shadowRoot.querySelectorAll('p').length
1

CSSが効かないのは「優先順位で負けた」のではありません。 セレクタが到達していないのです。 !important を付けても効きません。優先度の勝負ですらないからです。

Elements タブでも見えます。 <div id="host"> を展開すると、#shadow-root (open) という行が挟まっていて、その下に中身がぶら下がっています。この境界が、CSSもセレクタも通さない壁です。

[スクリーンショット: 03_shadow-root-elements.png] 開発者ツールの Elements タブで #shadow-root (open) の行が見えている状態を撮ってください。

これが React にはできないこと

Reactの className は、ただのクラス名です。

// React
<div className="card">…</div>

これは最終的に <div class="card"> というHTMLになるだけです。ページのどこかに .card { display: none } を書いた人がいれば、消えます。 CSSの回でやった、あの詳細度の勝負がそのまま起きます。

Reactの世界でCSSの衝突を避ける方法は、いくつもあります。

手段やっていること
CSS Modulesビルド時にクラス名を card_x7f2a のように書き換える
CSS-in-JSJavaScriptからクラス名を自動生成する
命名規則(BEMなど)人間が気をつけて衝突しない名前を付ける

どれも「衝突しない名前を頑張って作る」というアプローチです。 ページ全体が1つのCSSの空間である、という前提は変えていません。

Shadow DOM は、空間そのものを分けます。 中で p { color: blue } と書いても、それは外に存在しないルールになります。名前を工夫する必要すらありません。

「ビルドで名前を書き換えて回避する」のと、「そもそも届かない」のは、別のことです。 前者はビルドツールが要るうえ、後から誰かがグローバルCSSを足せば破れます。 後者は破れません。

:host — 部品の外枠を指す

Shadow DOM の中から、その部品自身にスタイルを当てたいときがあります。 中からは #host は見えないので、専用のセレクタを使います。

:host {
  display: block;
  border: 1px solid #ccc;
  padding: 12px;
}

:host は シャドウルートを持っている要素そのものを指します。

mode: ‘open’ と ‘closed’

host.attachShadow({ mode: 'open' });    // 外から shadowRoot で覗ける
host.attachShadow({ mode: 'closed' });  // shadowRoot が null になる

closed はセキュリティ機能ではありません。 同じページのJavaScriptは attachShadow を差し替えるなどいくらでも手があるので、悪意には勝てません。 単に「触らないでください」の意思表示です。デバッグが苦しくなるだけなので、open を使ってください。

わざと壊してみる

遮断を実感するために、1つ試してください。 外の <style> にこれを足します。

p { color: red !important; font-size: 20px; }

中の p は青のままです。 !important は同じ空間の中での優先度の話なので、届いていないものには何もできません。


③ <template> と <slot> だけを試す

3つ目です。 <template> は、書いてあるのに表示も実行もされないHTMLです。

<body> を書き換えます。

<body>
  <h1>③ template</h1>

  <template id="row-tpl">
    <li class="row">まだ表示されないはずの行</li>
  </template>

  <ul id="list"></ul>

  <button id="add">追加</button>

  <script>
    const tpl = document.querySelector('#row-tpl');
    const list = document.querySelector('#list');
    let n = 0;

    document.querySelector('#add').addEventListener('click', () => {
      n++;
      const node = tpl.content.cloneNode(true);
      node.querySelector('.row').textContent = n + ' 行目';
      list.appendChild(node);
    });
  </script>
</body>

リロードすると、リストは空です。 <template> の中に <li> を書いたのに、表示されません。 「追加」を押すたびに1行ずつ増えます。

[スクリーンショット: 04_template-clone.png] 「追加」を3回押して3行になった画面を撮ってください。

<template> は何がうれしいのか

「表示されない」ことそのものが機能です。

  • 中に <img src="..."> を書いても、画像は取りに行きません(HTTPキャッシュの回で見たリクエストが発生しない)
  • 中に <script> を書いても実行されません
  • document.querySelector('.row') でも取れません(テンプレートの中身は別の文書に置かれている)

tpl.content.cloneNode(true) で複製した瞬間に、初めて生きたDOMになります。 true は「子孫までまるごと」の意味で、これを忘れると空の器だけが複製されます。

innerHTML に長い文字列を組み立てるのと、何が違うのか。 DOM操作の回で書いたとおり、innerHTML に外から来た文字を混ぜるとXSSの入口になります。 <template> なら構造はHTMLに書いてあり、変わる部分だけ textContent で入れられます。 文字列を組み立てないので、そもそも危険が入り込みません。

<slot> — 中身を外から差し込む

<slot> は、部品の中に開けておく穴です。 Shadow DOM と組み合わせて使います。

<body>
  <h1>③-2 slot</h1>

  <div id="host2">
    <h2 slot="title">見出しは外から</h2>
    <p>本文も外から書いています。</p>
  </div>

  <script>
    const root2 = document.querySelector('#host2').attachShadow({ mode: 'open' });
    root2.innerHTML = `
      <style>
        .box { border: 2px solid #333; padding: 12px; border-radius: 6px; }
        .head { background: #eee; padding: 4px 8px; }
      </style>
      <div class="box">
        <div class="head"><slot name="title">無題</slot></div>
        <div class="body"><slot>本文がありません</slot></div>
      </div>
    `;
  </script>
</body>

枠と背景は Shadow DOM の中のもの、文字は外に書いたものです。

書き方どこに入るか
<slot name="title">slot="title" を付けた要素が入る
<slot>(名前なし)残り全部が入る
<slot>ここ</slot>何も差し込まれなかったときに出る既定の中身

Reactの children とほぼ同じ役割です。

// React
function Box({ title, children }) {
  return <div className="box"><h2>{title}</h2>{children}</div>;
}

ただし、決定的な違いが1つあります。

<slot> に差し込まれた中身は、Shadow DOM の中に「移動」しません。 表示位置だけが借りられます。 実体は外(ライトDOM)に残っているので、外のCSSが効きます。

つまり、さっきの例の <p>本文も外から書いています。</p> は、外の p { color: red } があれば赤くなります。 枠は守られるが、差し込まれた中身は守られない。 ここは最初、必ず混乱します。


④ 3つを組み合わせる

ここまで、3つを別々に触りました。 組み合わせると、ようやく「Web Components」になります。

~/web/wc.html を、これで丸ごと置き換えます。

<!DOCTYPE html>
<html lang="ja">
<head>
  <meta charset="UTF-8">
  <title>info-card</title>
  <style>
    body { font-family: sans-serif; padding: 24px; }
    p { color: red; }
  </style>
</head>
<body>
  <h1>④ 3つを組み合わせる</h1>

  <template id="info-card-tpl">
    <style>
      :host { display: block; margin-bottom: 12px; }
      .card { border: 1px solid #ccc; border-radius: 8px; padding: 16px; }
      .label { font-size: 12px; color: #777; }
      p { color: blue; }
    </style>
    <div class="card">
      <div class="label"></div>
      <slot>本文がありません</slot>
    </div>
  </template>

  <info-card label="メモ">
    <p>この p は外に書いてあります。</p>
  </info-card>

  <info-card label="注意">
    <p>2枚目のカードです。</p>
  </info-card>

  <script>
    class InfoCard extends HTMLElement {
      static get observedAttributes() { return ['label']; }

      connectedCallback() {
        if (!this.shadowRoot) {
          const tpl = document.querySelector('#info-card-tpl');
          this.attachShadow({ mode: 'open' })
              .appendChild(tpl.content.cloneNode(true));
        }
        this.render();
      }

      attributeChangedCallback() {
        if (this.shadowRoot) this.render();
      }

      render() {
        this.shadowRoot.querySelector('.label').textContent =
          this.getAttribute('label') || '';
      }
    }
    customElements.define('info-card', InfoCard);
  </script>
</body>
</html>

3つが全部入っています。

  1. Custom Elements — <info-card> というタグを作った
  2. Shadow DOM — 枠と余白のCSSが、外に漏れない
  3. <template> + <slot> — 型紙を複製し、中身を外から差し込む

Console で属性を変えてみてください。

document.querySelector('info-card').setAttribute('label', '変更した')

画面のラベルが変わります。 observedAttributes に 'label' を書いたので attributeChangedCallback が呼ばれ、render() が走ったからです。

書き忘れると、何も起きません。 試しに static get observedAttributes() の行を消してリロードし、同じことを打ってみてください。エラーも警告も出ないまま、無反応です。 これは実際にかなり長く悩みます。

[スクリーンショット: 05_info-card.png] 2枚のカードが枠付きで表示されている画面を撮ってください。中の p が赤い(差し込まれた中身なので外のCSSが効いている)ことが分かると理想です。

中の p は青ではなく赤になります。 <slot> に差し込んだ中身は外に属したままだからです。③で書いたとおりで、これが「思ったとおりに囲えていない」の正体です。 本当に中身まで隔離したければ、<slot> を使わず、部品の中でHTMLを組み立てます。 そのかわり、外から自由な中身を入れられなくなります。隔離と自由度は、ここでトレードオフになります。


⑤ ビルドが要らない

ここまで、一度も打っていないコマンドがあります。

bash
$ npm install
$ npm run dev
$ npm run build

1つも打っていません。 package.json もありません。node_modules もありません。あるのは wc.html という1枚のファイルだけです。

bash
$ ls -la ~/web

~/react-demo/ と比べます。

bash
$ du -sh ~/react-demo/node_modules
$ ls ~/react-demo

npmの回で見たとおり、node_modules は数百MBあります。

Web ComponentsReact
必要なファイルHTML 1枚package.json / vite.config.js / src/ …
インストール不要npm install(数百MB)
開発サーバー不要(静的配信でよい)npm run dev
公開用の変換不要npm run build → dist/
成果物に混ざるライブラリ0 バイトReact 本体(数十KB)

ビルドツールの回で「なぜ変換が要るのか」をやりました。 理由は JSXをブラウザが読めないからでした。

Web Components は、ブラウザがそのまま読める文法しか使っていません。 だから変換する理由が無いのです。

これは、Reactに対する2つ目の勝ち筋です。 「既存のページに部品を1つ足したい」だけのとき、Reactは道具立てが重すぎます。 <script> 1本で終わる場面が、実際にあります。


⑥ ではなぜ、主流にならなかったのか

標準で、ビルドが要らず、CSSまで隔離できる。 ここまで読むと「なぜ全員これを使わないのか」と思うはずです。

理由は3つあります。どれも正直に書きます。

1. 状態管理の仕組みが無い

これが最大の理由です。

Reactでは、こう書けば画面が追随しました。

const [count, setCount] = useState(0);
// setCount(count + 1) を呼ぶだけで、表示が更新される

Web Components に、これに当たるものはありません。

class Counter extends HTMLElement {
  #count = 0;   // 値を変えただけでは、画面は1ミリも変わらない

  increment() {
    this.#count++;
    this.render();   // ← 自分で呼ばないといけない
  }

  render() {
    this.shadowRoot.querySelector('.n').textContent = this.#count;
  }
}

「値が変わったら画面を直す」を、全部自分で書きます。

フレームワークの回で確認した問題が、そっくり戻ってきます。

同じ情報が2箇所(変数とDOM)にあって、一致させ続ける責任が全部自分にある

Web Components が解決したのは「部品の境界」であって、「状態と表示の同期」ではありません。 ここを取り違えると、Reactの代わりになると思って着手し、途中で行き詰まります。

状態管理の回でやったような話も、当然何も用意されていません。

2. 書く量が多い

同じ「ラベル付きカード」を並べます。

// React
function InfoCard({ label, children }) {
  return (
    <div className="card">
      <div className="label">{label}</div>
      {children}
    </div>
  );
}

6行です。 ④で書いた InfoCard は、<template> を含めて 30行以上でした。

内訳を見ると、どれも定型です。

  • attachShadow して cloneNode して appendChild
  • observedAttributes に属性名を並べる
  • attributeChangedCallback から render を呼ぶ
  • 属性は文字列なので、数値なら Number()、真偽値なら「属性があるか」で判定する

この定型を毎回書くのが嫌なので、Lit のような薄いライブラリが生まれました。 ただし、それを入れた時点で「ビルドが要らない」という長所を1つ削っています。

3. サーバーサイドレンダリングと相性が悪い

SSRの回で扱う話ですが、ここでも触れておきます。

カスタム要素は、JavaScriptが動いて初めて中身が入ります。 サーバーが返したHTMLの時点では、こうです。

<info-card label="メモ"></info-card>

空です。 curl で取ると、中身が入っていません。つまり、

  • JavaScriptを実行しない相手には、何も見えない
  • JavaScriptが読み込まれるまでの一瞬、レイアウトが崩れる(未定義のタグは高さ0)
  • innerHTML で組み立てた文字列は、検索エンジンのクローラの扱いが読みにくい

Reactにも同じ問題はありました。 だから Next.js のようにサーバー側でHTMLを組み立てる仕組みが用意されました。Web Components には、その仕組みが長らくありませんでした。

Declarative Shadow DOM(HTMLだけでシャドウルートを書ける仕組み)が2023年以降に各ブラウザへ入って状況は改善していますが、Reactの周辺に比べると道具が薄いままです。

まとめると

Reactが持っていて、Web Componentsに無いもの
状態が変わったら勝手に描き直す仕組み
短く書ける文法(JSX)
サーバーで先にHTMLを作る仕組み
ルーティング・テスト・エコシステム一式
Web Componentsが持っていて、Reactに無いもの
本物のCSSの隔離(Shadow DOM)
ビルド不要で動くこと
フレームワークに依存しないこと(=長く動く)

⑦ どこで使うか、どこで使わないか

両方の顔を見たので、使いどころを決めます。

使うところ

1. フレームワークをまたいで使い回す部品

会社に React のアプリと Vue のアプリと、素のHTMLのページがある、という状況はよくあります。「ボタンの見た目を全社で統一したい」とき、React で作ったボタンは Vue から使えません。

<acme-button> を Web Components で1つ作れば、3つ全部で使えます。 これがいわゆるデザインシステムの現実解として使われている理由です。

2. 既存のページに1つだけ足す

このサイトのように WordPress で動いているページに、「対応表を折りたためる部品」を1つだけ足したい。そのために Vite を導入して dist/ を作るのは、明らかに割に合いません。

<script src="/js/toggle-box.js"></script>
<toggle-box title="詳しく">…</toggle-box>

これで済みます。

3. 10年後も動いてほしいもの

ブラウザは後方互換を守ります。 Gitの回以降で扱ってきたどのツールよりも、標準の寿命は長いです。フレームワークのメジャーバージョンアップに追随しなくてよい、というのは実務では大きな価値です。

使わないところ

アプリ全体をこれで作らないでください。

  • 画面が状態で変わるものほど、⑥-1の「自分で render() を呼ぶ」が積み上がります
  • ページ遷移、フォーム、一覧の絞り込み。全部、手で同期を書くことになります
  • フレームワークの回で「もうやめよう」と決めたことを、そのままやり直す羽目になります

やりすぎない

この記事を読んだ直後にやりがちなことを、先に止めておきます。

  • ❌ ~/react-demo/ を Web Components で書き直す — 学びはありますが、⑥の3点に確実にぶつかります
  • ❌ すべての <div> をカスタム要素にする — タグが増えるだけで、何も良くなりません
  • ❌ Shadow DOM を全部に付ける — アクセシビリティの回でやったラベルの関連付けが、境界をまたげずに壊れます(後述)

このサイトは、引き続き React で進めます。 Web Components は「知っておくと選択肢が増えるもの」であって、乗り換え先ではありません。 ただし、Shadow DOM がCSSに対して何をしているかは、必ず覚えてください。 これは React 側の話をするときにも効きます。


つまずいたところ

"my-card" is not a valid custom element name と出る → ハイフンが入っていません。 <mycard> は作れません。<my-card> にしてください。①の理由のとおり、標準タグとの衝突を防ぐための仕様です。

同じ名前で2回 define して has already been defined と出る → customElements.define は同じ名前に2回できません。 ファイルを2回読み込んでいるか、<script> を書き足したままにしています。既存の登録は customElements.get('my-card') で確認できます。

属性を変えたのに、画面が変わらない → static get observedAttributes() に、その属性名を書き忘れています。 書いていない属性は attributeChangedCallback が呼ばれません。エラーも警告も出ないので、いちばん時間を溶かしました。

constructor の中で this.getAttribute() したら null だった → constructor の時点では、まだ属性が読まれていません。 属性を読む処理は connectedCallback に置きます。constructor では super() を呼び、DOMを触らないのが原則です。

constructor で super() を忘れて must call super constructor と出る → クラスを継承したら super() が必須です。JavaScriptの回の続きの文法で、Web Components 固有の話ではありません。

this.shadowRoot が null → attachShadow を呼んでいないか、mode: 'closed' にしています。 open にしてください。

cloneNode() したら中身が空だった → cloneNode(true) です。 引数を省くと false 扱いで、その要素だけが複製され、中の子要素が付いてきません。

外のCSSで、部品の中の文字色を変えたいのに変えられない → 正しい動作です。 どうしても外から変えたいときは、CSS変数(カスタムプロパティ)だけは境界を越えます。

/* 外 */
info-card { --card-border: 2px solid tomato; }
/* 中(Shadow DOM の style) */
.card { border: var(--card-border, 1px solid #ccc); }

「外から変えてよい点だけを、変数として穴を開ける」というのが定石です。

<slot> に入れた中身に、部品の中のCSSが効かない → ③に書いたとおりで、これも正しい動作です。 差し込まれた中身は外に属したままです。中から当てたいときは ::slotted(p) を使いますが、効くのは直下の要素だけという制限があります。

フォームに入れたのに、送信しても値が入っていない → Shadow DOM の中の <input> は、外の <form> からは見えません。 ここは仕様として複雑な領域で、ElementInternals という別の仕組みが要ります。この段階では、フォームをShadow DOMで囲まないのが安全です。

<label for="..."> が効かない → for と id は同じDOMツリーの中でしか結びつきません。 片方が Shadow DOM の中にあると、境界を越えられません。アクセシビリティの回でやった関連付けが、Shadow DOM では壊れます。 これも「全部に付けない」理由の1つです。

ホストのブラウザから開けない → sudo ufw allow 8000/tcp を忘れているか、--bind 0.0.0.0 を付けていません。Linuxのネットワークの回の切り分けの順番どおりに確認してください。

変更したのに、古い表示のまま → ブラウザのキャッシュです。 開発者ツールを開いた状態で Ctrl + Shift + R(スーパーリロード)を試してください。


後片づけ

開発用サーバーを止めます。

bash
$ # python3 -m http.server を動かしているターミナルで Ctrl + C

開けたポートを閉じます。

bash
$ sudo ufw delete allow 8000/tcp
$ sudo ufw status

~/web/wc.html は残して構いません。 消したいときはこれだけです。

bash
$ rm ~/web/wc.html

~/web/index.html と ~/react-demo/ は消さないでください。 どちらも後で比較対象として出てきます。


まとめ

  • 「コンポーネント」はReactの発明ではない。 ブラウザ標準の仕組みが別にあり、Reactより前から仕様がある
  • Web Components は1つの機能ではなく、3つの総称。 Custom Elements(タグを作る)/ Shadow DOM(隔離する)/ <template>・<slot>(型紙と差し込み口)
  • 3つは独立している。 どれか1つだけでも使える。まとめて覚えようとすると、何がどれの機能か分からなくなる
  • カスタム要素の名前にはハイフンが必須。 標準タグにハイフン入りが1つも無いので、縄張りを分ければ永久に衝突しないという後方互換のための取り決め
  • Shadow DOM は、外の p { color: red } を中に届かせない。 !important でも届かない。優先度の勝負ですらなく、セレクタが到達していない
  • document.querySelectorAll('p') の件数で確かめられる。 3つ書いても2しか返らない
  • これは React にできないこと。 CSS Modules も CSS-in-JS も「衝突しない名前を作る」であって、空間を分けてはいない
  • <template> は「表示されない」ことが機能。 中の <img> は取りに行かず、<script> も動かない。cloneNode(true) の true を忘れると空になる
  • <slot> に差し込んだ中身は、中に移動しない。 実体は外に残るので、外のCSSが効く。 枠は守られても、中身は守られない
  • npm も Vite も要らない。 ブラウザが読める文法しか使っていないので、変換する理由が無い
  • それでも主流にならなかった理由は3つ。 ①状態が変わっても勝手に描き直さない(render() を自分で呼ぶ)②書く量がReactの5倍(定型が多い)③SSRと相性が悪い(サーバーが返すHTMLは空)
  • Web Components が解決したのは「部品の境界」であって、「状態と表示の同期」ではない。 ここを取り違えると途中で行き詰まる
  • observedAttributes に書き忘れた属性は、変えても何も起きない。 警告も出ない。いちばん時間を溶かす罠
  • constructor では属性を読めない。 読むのは connectedCallback から
  • 外から中を調整したいときは CSS変数。 カスタムプロパティだけは境界を越える。「変えてよい点にだけ穴を開ける」
  • Shadow DOM は <label for> の関連付けを壊す。 フォームとの相性も悪い。全部に付けない
  • 使いどころは「フレームワークをまたぐ部品」と「既存ページに1つ足す」。 アプリ全体をこれで作らない
  • このサイトは引き続き React で進める。 Web Components は乗り換え先ではなく、選択肢を1つ増やすもの

参考リンク


次に読む

この記事は 【第4段階】フロントエンド の 11 / 15 本目です。

記事
← 前の記事クラス名を考えるのをやめる — Tailwind CSS
→ 次の記事node_modulesが重い理由 — pnpmとBunを測る

上から順に読めば積み上がるように並べています。 飛ばしても構いませんが、詰まったら前の回に戻ってください。

全体の順路は はじめに にあります。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次