JavaScript

素のJavaScriptでアコーディオンメニューを作る（クリックで開閉・jQueryなし・WAI-ARIA対応）

クリックで開閉するアコーディオンメニューを素のJavaScript（Vanilla JS）で制作する方法を解説します。ここでご紹介する内容は、他のサイトで紹介されているコートだと達成したい仕様が満たされなかったり、実装の仕方が悪いのか挙動がおかしかったりしたので、自作したものです。
使いまわしもしやすいコードで使いやすいものになっていると思いますので、ぜひご活用ください。
またウェブアクセシビリティのためのWAI-ARIAも対応しています。

目次

  1. 実装結果デモ
  2. アコーディオンメニューとは？
  3. アコーディオンメニューのメリットは？
  4. アコーディオンのデメリットは？
  5. 素のJavaScriptでアコーディオンメニューを制作する意義
  6. 実装したアコーディオンメニューの仕様
  7. 実装したアコーディオンメニュー仕様の理由
    1. １画面内に複数のアコーディオンメニューを配置
    2. １つ開いたら、他は閉じる
    3. スムーズに開閉するアニメーション
    4. 開いた時の高さは自動的に取得できるようにする
    5. 開いた時にスクロールを許容する
    6. 開閉のためのクリッカブルな箇所はbuttonタグで実装する
  8. アコーディオンメニュー実装内容の説明
    1. HTML
    2. CSS
    3. JavaScript
  9. アコーディオンメニュー開閉部の上下の隙間を調整したいとき
  10. アコーディオンメニューのアクセシビリティとSEOについて
  11. まとめ
SEOに強いAIライティングツール「BringRitera」 SEOに強いAIライティングツール「BringRitera」

実装結果デモ

まずは実装した結果をご確認ください。
後述する仕様のうち、アコーディオンを開いた時にスクロールを許容する部分はスクロールバーが存在するCODEPENだと表現が難しかったので、その点は別途ご自分でご確認いただければと思います。

余談

次の画像は前のアイキャッチ画像で、MicrosoftのClarityというサービスのヒートマップです。色がついている箇所がクリックされていることを示しています。このキャプチャ撮る前に画像を変えてしまったので、合成で再現してますが、大体こんな感じだったはずです。いや、みなさんせっかちすぎでしょ！クリックできそうですか？？
ってことで、↑のデモはもう少し下に置いてたんですが、申し訳ない気持ちになりまして、順番を変えました。

アコーディオンメニューとは？

アコーディオンメニューは、クリックで開閉し、開いた時だけ中のコンテンツを表示させるUIのことを指します。

アコーディオンメニューのメリットは？

ページ内に多くの情報が表示されていると、どの情報に注目したらよいのかが分かりにくくなります。ユーザーがより詳しく欲しいと思う情報を取捨選択できるようになるというメリットがあると言えます。

表示領域上の問題、つまりデザインのために用いるケースもあると思います。

アコーディオンのデメリットは？

開かないと表示されない情報は、ユーザーが開かない限りは気付かれないわけなので、その点がデメリットと言えます。そのことも踏まえ、クリックする部分に記載するメニュー名を分かりやすくし、そのメニューを見たいと思う人は気付きやすくなるような見た目を考えましょう。

クリッカブルな箇所は、開閉アイコン部分だけではなく、バー全体にしておく方が望ましいです。理由は上のヒートマップの画像を見ていただければわかるかと思います。

また、詳しくは後述しますが開かないと表示されない内容は、表示されてない間は非表示としてGoogleに伝わりますので、SEO対策として重要なコンテンツである場合は、アコーディオンメニューとせずに最初から表示しておいた方が望ましいと考えています。

素のJavaScriptでアコーディオンメニューを制作する意義

アコーディオンメニューはjQueryを使うともっと簡単に作成できます。ただ、ウェブサイトでjQueryを使うと簡単になるものというのは、逆に言えばアコーディオンメニューぐらいだと思います。

jQueryが広く使われてきた背景には、標準仕様のサポートが疎かだったIEのためだけに工夫しなければならないコーディングというのが多かったということがあります。jQueryはIEでも動く、という点で素晴らしいライブラリでした。
しかし、IEのサポートを考えなくて良くなり、Vanilla JSも進化している今となってはお役御免である状況であり、いつまでjQueryのサポートが続くかわかりません。

jQueryはそれなりの重さがあるので、用いればパフォーマンスへの影響は無視できないですし、実際にGoogleの評価ツールLigighthouseで評価するとかなり点数に違いが出ます。

素のJavaScriptで書く、ということに慣れた方が良いと考えます。

実装したアコーディオンメニューの仕様

達成したかった（実装した）仕様は以下の通りです。

  1. １画面内に複数のアコーディオンメニューを配置可能
  2. １つ開いたら、他は閉じる
  3. スムーズに開閉するアニメーション
  4. 開いた時の高さは指定しなくても自動的に取得できるようにする
  5. 開いた時にスクロールを許容する
  6. 開閉のためのクリッカブルな箇所は<button>で実装する

実装したアコーディオンメニュー仕様の理由

１画面内に複数のアコーディオンメニューを配置

上のデモのように、同一画面内に２か所のアコーディオンメニューがあっても動くようにしています。

１つ開いたら、他は閉じる

複数開いたままにできる仕様と、1つ開いたら他は閉じる仕様の両方が存在すると思います。両方開いて見比べたいとか、場合によっては前者の仕様の方が望ましいこともあるかもしれませんが、少なくともこのサイトのアコーディオンメニューは後者にした方が見やすいだろうと私は考えました。
ただ後者の方は「1つでも開いたら他は閉じる」ということをするわけなので、記録しておくべき情報が1種類増えて、実装難度は上がります。

スムーズに開閉するアニメーション

これはもはや当然ですが、スムーズに開閉するアニメーションを実装しています。また、開閉時にアイコンに変化をつけるということもしています。

開いた時の高さは自動的に取得できるようにする

アコーディオンメニューは、heightを0にすることで閉じ、開く分の高さを指定して開きます。CSSやJavaScriptのアニメーションでは、height: 0からheight: autoは変化がつかないので、開閉時のアニメーションを実装するには、開いた時の高さは指定する必要があります。あらかじめ高さを把握して、指定してしまう方法もありますが、それだと汎用性がありません。
（ちなみに、その方法であればJavaScriptを用いずにチェックボックスとCSSアニメーションだけを用いて実装する方法もありましたが、iOSでの表示がおかしかったのもあり、やめています）

開いた時にスクロールを許容する

スマートフォンのハンバーガーメニューで、アコーディオンメニューを開いたら縦の表示領域が足りなくなるため、スクロールを許容する必要がありました。

開閉のためのクリッカブルな箇所はbuttonタグで実装する

ボタンを<div>や<span>で実装する方法も見かけますが、以下2つの理由で、アクセシビリティのため避けた方がよいです。

１）キーボード操作できなくなり得る

<div>や<span>ではtabIndexをつけない限りキーボード操作ができません。tabIndexをつけたとしても、Enterボタンで押下できるようにするには、keyupイベントハンドラを実装する必要もあります。

２）スクリーンリーダーによる解釈が難しくなる

スクリーンリーダーは<button>はボタンであると把握して、その旨をユーザーに伝えます。しかし<div>はどうでしょうか。試しに現時点でどうであるかNVDAで試したところ、tabIndexをつけて、onClick属性をつけてクリック可能にした部分は、「ボタン、クリック可能です」と読み上げました。まあよくできたスクリーンリーダーですが、全てのスクリーンリーダーがそうであるとは限りません。

以上のようなことから、やはりHTMLの仕様に基づき、押せる部分は<button>で実装すべきです。先述のチェックボックスを用いるという方法もありますが、チェックボックスにチェックを入れたらメニューが表示される、という仕様があまり一般的ともいえないので、その意味でもJavaScriptを用いて<button>で実装することにしました。

なお、WAI-ARIAではボタンの役割を示すためにrole="button“という仕様がありますが、HTMLが使えるものについては、HTMLを使うべきとされているので、やはりここはbuttonタグを使うべきです。やむを得ない場合がもしあれば<div role="button">のように書く、というのがWAI-ARIAで用意されているものです。<button role="button">のように書くのは仕様に沿ってません。

アコーディオンメニュー実装内容の説明

HTML

  1. <ul class="include-accordion scroll-control">
  2.   <li>
  3.     <button class="accordionBtn" type="button">Menu-1</button>
  4.     <ul>
  5.       <li>List 1-1</li>
  6.       <li>List 1-2</li>
  7.       <li>List 1-3</li>
  8.     </ul>
  9.   </li>
  10.   <li>
  11.     <button class="accordionBtn" type="button">Menu-2</button>
  12.     <ul>
  13.       <li>List 2-1</li>
  14.       <li>List 2-2</li>
  15.       <li>List 2-3</li>
  16.     </ul>
  17.   </li>
  18.   <li>
  19.     <button class="accordionBtn" type="button">Menu-3</button>
  20.     <ul>
  21.       <li>List 3-1</li>
  22.       <li>List 3-2</li>
  23.       <li>List 3-3</li>
  24.     </ul>
  25.   </li>
  26. </ul>
  27.   
  28. <ul class="include-accordion scroll-control">
  29.   <li>
  30.     <button class="accordionBtn" type="button">Menu-1</button>
  31.     <ul>
  32.       <li>List 1-1</li>
  33.       <li>List 1-2</li>
  34.       <li>List 1-3</li>
  35.     </ul>
  36.   </li>
  37.   <li>
  38.     <button class="accordionBtn" type="button">Menu-2</button>
  39.     <ul>
  40.       <li>List 2-1</li>
  41.       <li>List 2-2</li>
  42.       <li>List 2-3</li>
  43.     </ul>
  44.   </li>
  45.   <li>
  46.     <button class="accordionBtn" type="button">Menu-3</button>
  47.     <ul>
  48.       <li>List 3-1</li>
  49.       <li>List 3-2</li>
  50.       <li>List 3-3</li>
  51.     </ul>
  52.   </li>
  53. </ul>
  • アコーディオンメニューがある一番外の<ul>にinclude-accordionのクラス名をつけます
    （1行目、28行目）
  • アコーディオンが開いた時にスクロールを許容したい要素にscroll-controlのクラス名をつけます
    （1行目、28行目）
  • アコーディオン開閉のためのクリック箇所となる<button>にaccordionBtnのクラス名をつけます
    （3行目、11行目、19行目、30行目、38行目）

クラス名は好きに変えて大丈夫です。
また、<ul>である必要はなく、例えば<div>でも同様に動きます。

CSS

  1. ul{
  2.   background-color: #35924A;
  3.   width: 150px;
  4.   padding: 0;
  5.   color: #fff;
  6.   float: left;
  7.   margin-left:30px;
  8. }
  9. li{
  10.   list-style: none;
  11. }
  12. .include-accordion ul{
  13.   height: 0;
  14.   padding: 0;
  15.   overflow: hidden;
  16.   transition: .5s;
  17.   border-top: 1px solid #67a863;
  18.   background-color: #5EAA6C;
  19.   margin:0;
  20. }
  21. .include-accordion li li{
  22.   border-bottom: 1px dotted #7FBF8B;
  23.   padding: 10px 0 10px 10px;
  24.   margin-left:15px;
  25. }
  26. ul:nth-of-type(1) li.active li:last-child{
  27.   border-bottom:1px solid #67a863; 
  28. }
  29. button{
  30.   position: relative;
  31.   border: none;
  32.   width: 100%;
  33.   background-color: inherit;
  34.   color: #fff;
  35.   cursor: pointer;
  36.   text-align: left;
  37.   padding: 15px 0 15px 20px;
  38.   font-size:1em;
  39. }
  40. button:hover{
  41.   background-color: #1A5B27;
  42. }
  43. button::before,
  44. button::after{
  45.   content:"";
  46.   position: absolute;
  47.   top: 50%;
  48.   width: 1.5px;
  49.   height: 8px;
  50.   background-color: #fff;
  51.   transition: .5s;
  52. }
  53. button::before{
  54.   transform: translateY(-50%) rotate(-45deg);
  55.   right: 35px;
  56. }
  57. button::after{
  58.   transform: translateY(-50%) rotate(45deg);
  59.   right: 30px;
  60. }
  61. li.active button::before{
  62.   transform: translateY(-50%) rotate(-135deg);
  63.   transition:.5s;
  64. }
  65. li.active button::after{
  66.   transform: translateY(-50%) rotate(135deg);
  67.   transition:.5s;
  68. }
  69. ul:nth-of-type(2){ background-color: #357D87; }
  70. ul:nth-of-type(2) ul{ background-color: #519FA5; border-top: 1px solid #5D9FA8; }
  71. ul:nth-of-type(2) button:hover{ background-color: #1C4B56; }
  72. ul:nth-of-type(2) li li{ border-bottom: 1px dotted #73BEBF; }
  73. ul:nth-of-type(2) li.active li:last-child{ border-bottom:1px solid #5D9FA8; }
  75. ul.active{ overflow-y: auto; }
  • 開閉する部分の初期の高さを0にして表示されないようにします（13行目）
  • overflow: hiddenで開閉する部分が表示された際にはみ出した分が表示されないようにします（15行目）
  • 閉じたときのアニメーションをCSSのtransitionでつけます（16行目）
  • 開閉のアイコンを疑似要素で作り、CSSのアニメーションで動かします（43～68行目）
    ※この部分は疑似要素でなくても問題はなく、自由に作って大丈夫です
  • 開いているときのulに対してスクロール許可します（75行目）

関係する部分は上記の通りで、あとは見た目、装飾のための記述です。

JavaScript

  1. <script>
  2. // 要素を表示する関数
  3. const slideDown = function(el) {
  4.   el.style.height = 'auto'; //いったんautoに
  5.   let h = el.offsetHeight;  //autoにした要素から高さを取得
  6.   el.animate({ // 高さ0から取得した高さまでのアニメーション
  7.     height: [ 0, h + 'px' ]
  8.   }, {
  9.     duration: 300, // アニメーションの時間
  10.    });
  11.    el.style.height = 'auto';  //ブラウザの表示幅を途中で閲覧者が変えた時を考慮してautoに戻す
  12.    el.setAttribute('aria-hidden', 'false');  //WAI-ARIA対応、閉じた状態であることを支援技術に伝える
  13. };
  15. // 要素を非表示にする関数
  16. const slideUp = function(el) {
  17.   let h = el.offsetHeight;
  18.   el.style.height = h + 'px';
  19.   el.animate({
  20.     height: [ h + 'px', 0]
  21.   }, {
  22.     duration: 300,
  23.    });
  24.    el.style.height = 0;
  25.    el.setAttribute('aria-hidden', 'true');  //WAI-ARIA対応、開いた状態であることを支援技術に伝える
  26. };
  28. let activeIndex = null;//開いているアコーディオン
  30. //アコーディオンコンテナ全てで実行
  31. const accordions = document.querySelectorAll('.include-accordion');
  32. accordions.forEach(function (accordion) {
  34.   //アコーディオンボタン全てで実行
  35.   const accordionBtns = accordion.querySelectorAll('.accordionBtn');
  36.   accordionBtns.forEach( function(accordionBtn, index) {
  37.     accordionBtn.addEventListener('click', function(e) {
  38.       activeIndex = index; //クリックされたボタンを把握
  39.       e.currentTarget.parentNode.classList.toggle('active'); //ボタンの親要素(ul>li)にクラスを付与／削除
  40.       accordionBtn.setAttribute('aria-expanded', isActive ? 'true' : 'false'); //WAI-ARIA対応、開いた状態かどうかを示す
  41.       const content = e.currentTarget.nextElementSibling; //ボタンの次の要素を取得
  42.       if (e.currentTarget.parentNode.classList.contains('active')) {
  43.          slideDown(content); //クラス名がactive（＝閉じていた）なら上記で定義した開く関数を実行
  44.       }else{
  45.          slideUp(content); //クラス名にactiveがない（＝開いていた）なら上記で定義した閉じる関数を実行
  46.       }
  47.       accordionBtns.forEach( function(accordionBtn, index) {
  48.         if (activeIndex !== index) {
  49.           e.currentTarget.parentNode.classList.remove('active');
  50.           e.currentTarget.setAttribute('aria-expanded', 'false'); //WAI-ARIA対応、開いた状態かどうかを示す
  51.           const openedContent = e.currentTarget.nextElementSibling;
  52.           slideUp(openedContent); //現在開いている他のメニューを閉じる
  53.         }
  54.       });
  55.       //スクロール制御のために上位階層のクラス名を変える
  56.       let container = accordion.closest('.scroll-control'); // クラス名がscroll-controlである近傍の要素
  57.       if (e.currentTarget.parentNode.classList.contains('active') == false && container) {
  58.         container.classList.remove('active')
  59.       }else if (container !== null){
  60.         container.classList.add('active')
  61.       }
  62.     });
  63.   });
  64. });
  65. </script>

細かい部分はコメントアウトの記述で記載していますので、あとは大まかに、何をしているのかを説明します。

  • 開くときにheight: 0からいったんheight: autoにして高さを取得してからその高さを指定する、ということをしています。
  • 開いた後、閲覧者がブラウザの幅を変えたときに高さが指定されたままだと表示が崩れるので、アニメーションが動いた後に高さをautoに戻しています。
    ※この記事を書いた当初、autoに戻さず、閉じるときは高さが指定された状態からheight: 0へとCSSのアニメーションで動かしてましたが、ブラウザの幅が変わった時に表示が崩れるということに気づき修正しています。
  • height: 0からheight: auto、あるいはその逆のアニメーションに関して、CSSではうまくつけられず（方法ご存じの方いればご連絡ください！）、JavaScriptのanimate()メソッドを利用しています。これは比較的新しい仕様ですが、2020年にSafariが対応し、IEを除く主要なブラウザでは動きます。
    ※この部分について、繰り返し処理を用いて少しずつ高さを足していく、という方法を取っているものもあると思いますが（未確認ですがjQueryはそれ？）、ブラウザに組み込まれた処理なので、それよりもパフォーマンスが良いはずです。
  • クリックされたボタンをactiveIndex（変数名なので名称は自由）で定義した変数で把握し、あるボタンがクリックされたときに、他のボタンの次の要素を閉じる、ということをしています。
    ※開いた部分は閉じない限り開いておく仕様にする場合は、この部分が不要となりますので、28行目、38行目、47～53行目を削除してください。
  • アコーディオンメニューをクリックしたときの関数のところ修正しました（2023年2月15日）。元々は引数をeにして、クリックされた要素を基準にクラス名activeの付与／削除する要素を決めていました。それだとアコーディオンメニューの中が複雑な時に不具合が生じることに気付きまして、あくまでもaccordionBtnのクラス名がついている要素を基準にクラス名activeの付与／削除する要素を決める形に変更しました。その方がシンプルでもあり、元々のは、どうしてそうしていたのでしょうか（笑）。
  • ボタンに対しては、開閉させている部分が開いた状態かどうかを示すaria-expanded属性をつけています。開閉する部分には、それが表示された状態かどうかを示すaria-hidden属性を付与しています。これらはWAI-ARIAという仕様で、スクリーンリーダーなどの支援技術に対して状態を示すためのものです。ウェブアクセシビリティ対応となります。

アコーディオンメニュー開閉部の上下の隙間を調整したいとき

開閉部は、heightを0にすることで非表示にしているので、開閉部の最上位要素にpaddingやmarginの縦方向に値をつけると隙間が空いてしまいます。

例えば次のような場合に、dd要素にpaddingやmarginをつけるのではなく、p要素にpaddingやmarginをつければ、閉じているときは非表示に、開いているときはつけられたpaddingやmarginが反映された形で表示されます。

  1. <dl class="faq-container include-accordion">
  2.    <dt class="accordionBtn"><button>駐車場はありますか？</button></dt>
  3.    <dd><p>駐車場は２台分あります。</p></dd>
  4. </dl>

アコーディオンメニューのアクセシビリティとSEOについて

jQueryによるアコーディオメニューは、閉じているときはdisplay: noneで、開いているときはdisplay: blockになっていると思われます。

スクリーンリーダーは、display: noneは表示されてないものとして無視します。しかしheight:0で非表示になっているものは、無視はしません。アクセシビリティ上、どちらがいいかというと、画面上では非表示にしているので、本来は無視してもらった方が良いかもしれません。とはいえ、飛ばしながら読み上げられるので、大きな問題とは思いません。

SEO上どうかで考えると、スクリーンリーダーが無視するものは、Googleも分析上無視して見ていると考えた方が無難だと思っています。以前、キーワードが単純にたくさん含まれている方が有利だったような時代に、display: noneで非表示にしたキーワードをたくさん埋め込むという、いわゆる隠しテキストが使われて、そういったものはGoogleからペナルティが与えられるようになりました。よって、display: noneやvisibility: hiddenはSEO上のことをよく考えて使った方が良いと私は考えており、jQueryのようにdisplay:noneで非表示にするよりも、height: 0で非表示にしている本実装方法の方がSEO的には有利である可能性があると思っています。WAI-ARIAも合わせて実装しておけば間違いないかと思ってます。

まとめ

jQueryなしでアコーディオンメニューを作る方法を説明しました。
求めた仕様が割と複雑ですが、決めたクラス名をつけるだけでよくて、汎用性がある状態にできたと思ったので、ご紹介しました。
ご指摘や改善点、感想などあれば問い合わせフォームからいただければ幸いです。

SEOチェックシート
ダウンロード 無料相談
著者のイメージ画像

株式会社BringFlower
稲田 高洋（Takahiro Inada）

2003年から大手総合電機メーカーでUXデザインプロセスの研究、実践。UXデザイン専門家の育成プログラム開発。SEOにおいても重要なW3Cが定めるWeb標準仕様策定にウェブアクセシビリティの専門家として関わる。2010～2018年に人間中心設計専門家を保有、数年間ウェブアクセシビリティ基盤委員も務める。その後、不動産会社向けにSaaSを提供する企業の事業開発部で複数サービスを企画、ローンチ。CMSを提供し1000以上のサイトを分析。顧客サポート、サイト運営にも関わる。
2022年3月に独立後、2024年4月に株式会社BringFlowerを設立。SEOコンサルを活動の軸に据えつつ、AIライティングツールの開発と運営を自ら行う。グッドデザイン賞4件、ドイツユニバーサルデザイン賞2件、米国IDEA賞1件の受賞歴あり。

ノウハウ一覧
SEOに強いAIライティングツール「BringRitera」 SEOに強いAIライティングツール「BringRitera」