Web Componentsを使ってみよう

2019.10.23.水
JavaScript

溝畑です。
随分間が空いてしまいました。前回は去年のVue Fesの投稿・・・。
今年のVue Fesは台風で中止になっちゃいましたね。。。仕方ない。

Qiita Teamにはやたら落書きしてたり、個人ブログにはちょいちょい書いてるんですけど、こっちには書かずでした。

Web Components

さて、本題。
Web Components使ってますか?
自分もやっと触ろうかなーと言ったレベルで、今回触ってみたまでです。

そもそもWeb Componentsって何ですか?という方向けに。
こんなこと思ったことないですか?

・自作タグ作ってHTML書けたらなー!
・HTML書きまくると読みにくいし、もうしんどいー嫌やー!

読みにくいかどうかは書き手の問題感が否めないですが、それは置いておいて。
こんな思いに応えてくれるのが「Web Components」です。

詳しいことはこっち読んでもらって↓
Web Components | MDN

Web Components は、再利用可能なカスタム要素を作成し、ウェブアプリの中で利用するための、一連のテクノロジーです。


こういうことです。
JSのフレームワーク触ってる方なら馴染み深い、Componentを作って組み合わせるあの感覚です。
あれに近いことができるよ!というイメージが近いと思います。

身近で使われているところをあげると、Youtubeなんかではバリバリ使われてます。
要素の検証なりしてみると、ytb-xxxx、yt-xxxxみたいなタグが見えるはず。

Web Componentsの使い方(1)

基本的な使い方から見てみましょう。
<kp-link></kp-link>というタグで、弊社のHPへのリンクを表示するものを作ってみます。


これで、↓みたいなのが表示されます。

まず、classを作って、HTMLElementを継承。
constructorではthis.attachShadow({ mode: ‘open’ })として、shadowRootを作ります。
これが作るComponentの根本になります。
あとはshadowRootのinnerHTMLにHTMLとスタイルを定義。

最後にcustomElements.defineで使うタグ名と作ったクラスを入れて完了。
これで使えるようになります。
意外と簡単。

さらっと出てきているattachShadowのmodeですが、openとclosedがあります。
違いは「外部のJavaScriptからアクセスできるかどうか」です。
外から触られたくないわー!ならclosedってな感じでしょうか。

Web Componentsの使い方(2)

(1)だけだと、中で書いたHTMLしか表示できません。
例えば、タブなんかを作るときはタブのタイトル部分とコンテンツ部分は外部から挿入したいはずです。
そういった場合は<slot></slot>を使うと解決できます。
(Vueにもslotありますね)

次は<my-tab></my-tab>で簡単なタブを表示してみましょう。


これでこんな感じのタブが表示されます。

ちょっと長いのと、多分もっとスッキリ書けそうですが・・・。
ざっくりやってることだけ。

全体的な流れは同じです。
selectedTabIndexが選択中のタブのindex。
tabTitleNodes、tabContentNodesにはそれぞれのNodeを入れてます。

はじめにstyleを見てみると、見慣れない::slottedという疑似要素を使っています。
その名の通り、slotで放り込まれた要素に対してスタイルをあてることができます。その他hostなんかもありますが、調べてみてください!

次にconnectedCallback。
いわゆる、ライフサイクルメソッドです。(React, Vue, Angularなんかでも、Componentのライフサイクルってありますよね)
これは、要素がDOMに追加されたら走ります。

最後にassignedNodes()。
slotで追加された要素を引っ張り出せます。

あとは、tabTitleにclickイベントを仕込んで、selectTabでclassListを操作しています。

ちょっとややこしいですかね。。。
とはいえ、これで外部から挿入する方法が分かりました。

さいごに

これだけだとまだ不安はありますが、しっかりやればUIライブラリ的なのが作れる!?
とにかく、複雑なHTMLやCSSを中に閉じ込めることができるので、冒頭で書いたような「読みにくいし」といったことも軽減できます。

例えば、弊社のWebFileなら<wf-button>みたいなイメージでやると、サービス内ではそれを使っておけば、誰がやっても見た目に関する揺れも少なく済みそうです。

これからWeb Componentsが浸透していくのでしょうか。楽しみです。

-->