にしし ふぁくとりー:西村文宏 個人サイト

Presented by Nishishi via Movable Type. Last Updated: 2020/06/23. 11:09:42.

HTML内にdata-lightbox属性があれば動的にLightboxを読み込むようJavaScriptを書いてみた

常時Lightbox用のJavaScriptとCSSを読み込ませるのは通信量の無駄な気がしたので、必要な場合に限って動的に読み込ませるよう書いてみました

ブログ記事の中に時々大きな画像を掲載して見せたいことがあるので、初期状態ではサムネイル画像だけを見せておき、拡大版画像はLightboxを使って表示できるようにしました。しかし、毎回の記事で大きな画像を掲載しているわけではありませんから、問答無用で常時Lightboxを読み込んでしまうように記述すると、無駄に通信量が増えてしまって望ましくないようにも思いました。

そこで、Lightboxを必要とする「data-lightbox」属性がHTML内のどこかに1つ以上存在している場合のみ、Lightbox用のCSSとJavaScriptをCDNから動的に読み込むJavaScriptをjQueryで書いてみました。

必要な場合に限ってLightboxのJavaScriptとCSSを動的に読み込むソース

Lightboxを動的に読み込ませる方法として書いたJavaScriptソースは下記の通りです。
(jQueryは既に読み込まれていることが前提になっています。)

$(function() {
   // ▼body要素内に「data-lightbox」の文字列がある場合に限って
   if( $('body').html().indexOf('data-lightbox') >= 0 ) {
      // ▼LightboxのCSSを動的に読み込む
      var lbcss = document.createElement('link');
      lbcss.rel = 'stylesheet';
      lbcss.href = 'https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.0/css/lightbox.min.css';
      document.head.appendChild(lbcss);
      // ▼LightboxのJavaScriptを動的に読み込む
      var lbjs = document.createElement("script");
      lbjs.src = "https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.0/js/lightbox.min.js";
      document.body.appendChild(lbjs);
   }
});

書いていることは単純で、body要素の中身を全部取得して、indexOfメソッドを使って data-lightbox の文字列が存在するかどうかをif文で判定しています。data-lightboxの記述が1つ以上あれば、if文の中身が実行されます。

if文の内側では、Lightbox用のCSSファイルとJavaScriptファイルをCDNから動的に読み込んでいます。

動的に読み込ませる処理は簡単で、document.createElement('要素名')でlink要素やscript要素を生成し、必要な属性値を指定して、document.head.appendChildでhead要素の末尾に加えてやれば良いだけです。そうするだけで、ブラウザはそのソースを読み込んでくれます。

備考:jQueryが読み込まれていない状況の場合

私のサイトではjQueryは(ほぼ)常用しているので、jQueryは(動的には読まず)常に読み込ませています。
もしjQueryもLightboxと一緒に動的に読ませたいなら、jQueryの記述は当然使えませんから、例えば$(function() { ~ });の代わりにはdocument.addEventListener("DOMContentLoaded", function() { ~ });と書いたり、$('body')の代わりにはdocument.getElementsByTagName('body')[0]などの記述方法を使ったりすれば良いのではないかと思います。たぶん。

モバイル環境ではLightboxは読ませないようにしたい

先程のソースは話を簡単にするためにbody要素を対象にしましたが、広大な範囲を対象にして文字列を探すのは処理の無駄が多すぎるような気がしましたので、私のサイトでは「id="container"」が指定された範囲だけを対象にするように書きました。ブログ記事の本文は、このid名の範囲内にありますので。まあ、現代の閲覧環境ならbody要素全体を対象にしたところで、体感速度に変わりはないとは思うのですが。省ける無駄は省いておくに越したことはないかなとも思いまして。

あと、画面幅の狭いモバイル環境では、Lightboxを使っても大して拡大できない(または全く拡大されない)ことがよくあるので、Lightbox自体を読み込ませることが無駄だとも思います。むしろ、Lightboxを使わずに素直に画像への通常リンクの形にした方が最大限拡大できて良さそうな気もします。

というわけで、「閲覧者の画面幅が800px以上の場合」かつ「id="container"が指定された要素が存在する場合」だけに限ってLightboxが必要かどうかの判定をするよう、以下のように書いてみました。

$(function() {
   // ▼画面幅が800px以上で、id="container"が存在する状況で
   if(( window.screen.width >= 800 ) && ( document.getElementById('container') )) {
      // ▼body要素内に「data-lightbox」の文字列がある場合に限って
      if( $('#container').html().indexOf('data-lightbox') >= 0 ) {
         // ▼LightboxのCSSを動的に読み込む
         var lbcss = document.createElement('link');
         lbcss.rel = 'stylesheet';
         lbcss.href = 'https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.0/css/lightbox.min.css';
         document.head.appendChild(lbcss);
         // ▼LightboxのJavaScriptを動的に読み込む
         var lbjs = document.createElement("script");
         lbjs.src = "https://cdnjs.cloudflare.com/ajax/libs/lightbox2/2.11.0/js/lightbox.min.js";
         document.body.appendChild(lbjs);
      }
   }
});

上記のJavaScriptによって、以下の3条件を満たしている場合にだけ、LightboxのJavaScriptとCSSが動的に読み込まれます。

  1. 閲覧環境の画面サイズが800px以上
  2. id="container" が付加された要素が存在する
  3. その中に「data-lightbox」の記述がある

なお、ここでwindow.screen.widthを使ったのは、ブラウザのウインドウサイズではなく、画面サイズで判断したかったためです。PC環境で、たまたまブラウザのウインドウサイズが800px未満だった場合には、ユーザが自分の意思でウインドウサイズを広げればLightboxが使える方が楽でしょうから。

もし、ブラウザのウインドウ幅など「描画領域の横幅」を使いたい場合は、document.body.clientWidthを使えば良いと思います。

とはいえ、これで本当に無駄が省けるのかどうかはイマイチ自信がないのですけども(笑)

このJavaScriptを実行する速度(=HTMLソース内の一定領域内に指定の文字列が存在するかどうかを確認して、あったら外部ファイルを読み込む処理をする速度)のことを考えたら、最初から問答無用でLightboxを読み込ませてもあまり変わらないのかも知れません。LightboxのCSSはわずか2.5KBで、JavaScriptは9.05KBですから両方で11.5KB程度しかありません。初回は読み込みに時間がかかるとしても2度目からはキャッシュから読まれるわけですし、何よりCDNから読み込んでいるので初回アクセスの時点でも既にユーザのブラウザにはキャッシュが存在する可能性もあります。(そもそもそういう状況を期待しているからこそCDNから読み込ませているわけで。)

なので、そこまで気にしても実は意味がないのかも知れません。
どうなのかな……。(^_^;;;

ただ、自前のスクリプトで動的に読み込むかどうかを判断するメリットの1つとして、「画面サイズが狭い場合には読まない」ようにできる点はあります。
たとえdata-lightbox属性が付加されていたとしても、モバイル端末ではLightboxは読み込まれませんから、モバイル閲覧環境でだけは無駄な通信を確実に排除できている気はします。^^;

コメント

コメント数: 0件

コメント投稿欄 この日記に対するコメント投稿を歓迎します。



※本文中にURLは書けません。(書くと投稿が拒否されますのでご注意下さい。)

※ご投稿頂いた内容は、掲載前に管理者が確認する設定にしている場合があります。たいていは数日以内には表示されるはずですので、気長にお待ち願います。m(_ _)m

著者紹介


にしし(西村文宏)

にししでございます。本書いたり記事書いたりしてます。あと萌えたり。著書5冊発売中です(Web製作系4冊+小説1冊)。著書や記事は「西村文宏」名義。記事は主にAll Aboutで連載。本の最新刊は2011年3月に発売されたライトノベルでございますよ。

Twitter:にしし/西村文宏
にしし/西村文宏 on facebook にしし/西村文宏 on mixi フォローはお気軽に!

にしし(西村文宏)連絡先
☕ コーヒーをおごる

著書一覧と詳細

関連する記事など

※下記には、本サイト内外の関連記事などが8本くらい自動で表示されています。

にししふぁくとりー Sakura scope内限定での主要なカテゴリ

--- 当サイト内を検索 ---