【SANGO】スマホで目次を追従させるカスタマイズ

「PCで目次が追尾されるようにスマホでも目次を追尾させたい」とカスタマイズ依頼がありました。

WordPressでの実装ですがテーマ毎にやり方が異なるので分けてカスタマイズ方法を紹介しています。

動作確認デモはこのブログです。スマホで見てみてください。

このブログはSANGOではなくCocoonですが動きはほとんど同じになっています。

コピペでできるようになっていますが一部自身の環境に合わせて位置や色を各々変更する必要があります。

SANGOでスマホ時に目次を追尾させる方法！

手順は以下の通りです。

STEP1：CSSをコピペ！

下記コードをコピペしてください。

/************************************
** スマホ追尾目次
************************************/
#mobile-toc-widget-wrap .menu-trigger,
#mobile-toc-widget-wrap .menu-trigger span {
    display: inline-block;
    transition: all .4s;
    box-sizing: border-box;
}
#mobile-toc-widget-wrap .menu-trigger {
    position: relative;
    width: 25px;
    height: 35px;
}
#mobile-toc-widget-wrap .menu-trigger span {
    position: absolute;
    left: 0;
    width: 100%;
    height: 3px;
    background-color: #fff; /* 三本線色 */
    border-radius: 4px;
}
#mobile-toc-widget-wrap .menu-trigger span:nth-of-type(1) {
    top: 13px;
}
#mobile-toc-widget-wrap .menu-trigger span:nth-of-type(2) {
    top: 20px;
}
#mobile-toc-widget-wrap .menu-trigger span:nth-of-type(3) {
    top: 27px;
}
#mobile-toc-widget-wrap .menu-trigger.active {
    -webkit-transform: rotate(360deg);
    transform: rotate(360deg);
}
#mobile-toc-widget-wrap .menu-trigger.active span:nth-of-type(1) {
    -webkit-transform: translateY(20px) rotate(-45deg);
    transform: translateY(20px) rotate(-45deg);
    top:0;
}
#mobile-toc-widget-wrap .menu-trigger.active span:nth-of-type(2) {
    -webkit-transform: translateY(0) rotate(45deg);
    transform: translateY(0) rotate(45deg);
}
#mobile-toc-widget-wrap .menu-trigger.active span:nth-of-type(3) {
    opacity: 0;
}
#mobile-toc-widget-wrap{
    position: fixed;
    bottom: 50px;
    right: 20px;
    margin: 0;
    padding: 0;
    z-index:100;
    counter-reset: mobile-toc;
}
#mobile-toc-widget-wrap label .mobile-toc-button {
    width: 58px;
    height: 58px;
    border-radius:50%;
    background: #58a9ef; /* ボタン色 */
    box-shadow: 0px 2px 6px rgba(0, 0, 0, 0.16);
    transition: ease-out 0.3s;
    text-align:center;
    position:relative;
    z-index: 3;
}
#mobile-toc-widget-wrap label .mobile-toc-button .mobile-toc-button-title {
    color: #fff; /* ボタン文字色 */
    font-size: 0.65em;
    letter-spacing: 0;
    position: absolute;
    bottom: 7px;
    left: 0;
    right: 0;
    margin: auto;
}
#mobile-toc-widget-wrap label:hover {
    background: #efefef;
}
#mobile-toc-widget-wrap input {
    display: none;
}
#mobile-toc-widget-wrap .mobile-toc-show {
    display:none;
}
#mobile-toc-widget-wrap input:checked ~ .mobile-toc-show {
    background:#fff;
    position: absolute;
    top: 0;
    left: 0;
    padding: 2.5em 1em;
    opacity:0.97; /* 20190924数値変更 */
    position:fixed;
    width:100%;
    height:100%;
    display:block;
    animation: 0.5s fade-in;
    -webkit-animation: 0.5s fade-in;
    overflow-y:scroll;
}
@-webkit-keyframes fadeIn { 
  0% {display: none;opacity: 0;}
  1% {display: block;opacity: 0;}
  100% {display: block;opacity: 0.93;}
}
@keyframes fade-in {
  0% {display: none;opacity: 0;}
  1% {display: block;opacity: 0;}
  100% {display: block;opacity: 0.93;}
}
#mobile-toc-widget-wrap .widgettitle{
    text-align: center;
    margin: 0 0 1em; /* 20190924数値変更 */
    color: #58a9ef; /* 目次名の色 */
    font-size: 1.1em;
    letter-spacing:2px;
    background:none;
    font-weight:600; /* 20190924追加 */
}

目次プラグイン「TOC+」利用者専用CSS

/************************************
** スマホ追尾目次 TOC
************************************/
#mobile-toc-widget-wrap .toc_widget_list{
    font-size:0.8em;
    padding:0 !important;
}
#mobile-toc-widget-wrap .toc_widget_list a{
    text-decoration:none;
    color:#555; /* 目次リストの色 */
    font-weight:600; /* 20190924追加 */
}
#mobile-toc-widget-wrap .toc_widget_list > li {
    list-style-type: none !important;
    position: relative;
    margin-left: 13px;
    margin-right: 25px;
    padding-left: 32px;
    margin-bottom: 15px;
    padding-bottom: 0px;
    font-size: 1.1em;
    line-height: 1.6; /* 20190924数値変更 */
}
#mobile-toc-widget-wrap .toc_widget_list > li:before{
    counter-increment: mobile-toc;
    content: counter(mobile-toc);
    position: absolute;
    left: 5px;
    top: -1px;
    background: none;
    font-size: 1.1em;
    color: #58a9ef; /* 数字の色 */
}
#mobile-toc-widget-wrap .toc_widget_list > li ul {
    margin-top: 5px;
    padding-left: 20px;
    list-style:none;
}
#mobile-toc-widget-wrap .toc_widget_list > li > ul > li a {
    position: relative;
    text-decoration: none !important;
    font-weight:500; /* 20190924追加 */
}
#mobile-toc-widget-wrap .toc_widget_list > li ul li a:before {
    position: absolute;
    content: "・";
    font-size: 1.4em;
    left: -20px;
    top: -10px;
    color: #58a9ef; /* 点の色 */
}

目次プラグイン「Easy Table of Contents」利用者専用CSS

/************************************
** スマホ追尾目次 Easy Table of Contents
************************************/
#mobile-toc-widget-wrap .ez-toc-list{
    font-size:0.8em;
    padding:0 !important;
}
#mobile-toc-widget-wrap .ez-toc-list a{
    text-decoration:none;
    color:#555; /* 目次リストの色 */
    font-weight:600; /* 20190924追加 */
}
#mobile-toc-widget-wrap .ez-toc-list > li {
    list-style-type: none !important;
    position: relative;
    margin-left: 13px;
    margin-right: 25px;
    padding-left: 32px;
    margin-bottom: 15px;
    padding-bottom: 0px;
    font-size: 1.1em;
    line-height: 1.8;
}
#mobile-toc-widget-wrap .ez-toc-list > li:before{
    counter-increment: mobile-toc;
    content: counter(mobile-toc);
    position: absolute;
    left: 5px;
    top: -1px;
    background: none;
    font-size: 1.1em;
    color: #58a9ef; /* 数字の色 */
}
#mobile-toc-widget-wrap .ez-toc-list > li ul {
    margin-top: 5px;
    padding-left: 20px;
    list-style:none;
}
#mobile-toc-widget-wrap .ez-toc-list > li > ul > li a {
    position: relative;
    text-decoration: none !important;
    font-weight:500; /* 20190924追加 */
}
#mobile-toc-widget-wrap .ez-toc-list > li ul li a:before {
    position: absolute;
    content: "・";
    font-size: 1.4em;
    left: -20px;
    top: -10px;
    color: #58a9ef; /* 点の色 */
}

色は全てコメントに書いてあるので変更したい場合はカラーコードを変更してください。

ボタンの位置を調整

フッターに固定メニューだったりトップへ戻るボタンなど設置している人はボタンの位置を調整する必要があります。

実装後、もしボタンの位置が被ってしまっていたらCSSで位置を変更します。

位置調整は50行目から51行目にあるbottomとrightの数値を変更すればOK。

になります。

スマホの画面を更新しながら確認してみてください。

STEP2：function.phpを編集

function.phpに下記コードをコピペします。

コピペをミスっただけでも開けなくなる可能性があるので
必ずバックアップを取ってから行なってください。

//目次スマホ追尾専用ウィジェット
add_action(
  'widgets_init', 
  function(){
    register_sidebar(array(
      'id' => 'mobile_toc_widget',
      'name' => '目次スマホ追尾',
      'description' => 'スマホだけに表示される追尾される目次専用エリアです。',
      'before_widget' => '',
      'after_widget' => '',
      'before_title' => '<div class="widgettitle">',
            'after_title' => "</div>\n"
    ));
  }
);
//目次スマホ追尾
function foot_customtags() {
if ( wp_is_mobile()  && is_single()) : 
if(is_active_sidebar('mobile_toc_widget')) : 
echo <<<EOM
<div id="mobile-toc-widget-wrap">	
    <label for="mobile-toc">
    <div class="mobile-toc-button">
      <div class="menu-trigger">
      <span></span>
      <span></span>
      <span></span>
      </div>
     <span class="mobile-toc-button-title">目次</span>
    </div>
  </label>
    <input type="checkbox" id="mobile-toc"/>
    <div class="mobile-toc-show">
      <div class="mobile-toc-widget">   
EOM;
dynamic_sidebar('mobile_toc_widget');
echo <<<EOM
</div>
</div>
</div>
EOM;
endif;
endif;
}
add_action( 'wp_footer', 'foot_customtags' );

ボタンの文字(目次)を変更したい場合は29行目の「目次」の名称を変更してください。

STEP3：JavaScriptをSANGOで使えるようにする

こちらの記事を参考にしています。

公式 カスタマイズでJavaScriptを利用する方法

FTPソフトを使って子テーマにファイルを作成します。

sango-theme-childにscripts.jsという名前のファイルを作ってください。

ファイルを作成したらfunction.phpを編集します。

下記コードがもともと書いてあると思います。

//子テーマのCSSの読み込み
add_action( 'wp_enqueue_scripts', 'enqueue_my_child_styles' );
function enqueue_my_child_styles() {
  wp_enqueue_style( 'child-style', 
  	get_stylesheet_directory_uri() . '/style.css', 
  	array('sng-stylesheet','sng-option')
  );
  
}

そこに新たに追加するコードがこちら

//jsの読み込み
wp_enqueue_script( 'sng-js', 
      get_stylesheet_directory_uri() . '/scripts.js', 
      array(), '', true );

最終的にこのようになっていればOK！

//子テーマのCSSの読み込み
add_action( 'wp_enqueue_scripts', 'enqueue_my_child_styles' );
function enqueue_my_child_styles() {
  wp_enqueue_style( 'child-style', 
  	get_stylesheet_directory_uri() . '/style.css', 
  	array('sng-stylesheet','sng-option')
  );
  
//jsの読み込み
  wp_enqueue_script( 'sng-js', 
        get_stylesheet_directory_uri() . '/scripts.js', 
        array(), '', true );
}

これでSANGOでJavaScriptが使えるようになりました。

STEP4：JavaScriptをコピペ

作成したscripts.jsにコードをコピペします。

使っている目次プラグインのコードをコピペしてください。

目次プラグイン「TOC+」利用者コード

jQuery('#mobile-toc-widget-wrap label').on('click', function() {
    jQuery('.menu-trigger').toggleClass('active');
});
jQuery('#mobile-toc-widget-wrap .toc_widget_list a').on('click', function() {
    jQuery('.menu-trigger').toggleClass('active');
});
jQuery('#drawer__input').on('click', function() {
    if (jQuery('#drawer__input').prop('checked')) {
        jQuery('#mobile-toc-widget-wrap').css('display', 'none');
    }else{
    jQuery('#mobile-toc-widget-wrap').css('display', 'block');
  }
});
jQuery('#mobile-toc-widget-wrap .toc_widget_list a').click(function() {
    if (jQuery('#mobile-toc-widget-wrap input').prop('checked')) {
        jQuery('#mobile-toc-widget-wrap input').prop('checked', false);
    }
});
jQuery(function () {
 var headerHight = 50; 
 jQuery('a[href^="#"]').click(function(){
     var href= jQuery(this).attr("href");
       var target = jQuery(href == "#" || href == "" ? 'html' : href);
        var position = target.offset().top-headerHight;
     jQuery("html, body").animate({scrollTop:position}, 550, "swing");
        return false;
   });
});

目次プラグイン「Easy Table of Contents」利用者コード

jQuery('#mobile-toc-widget-wrap label').on('click', function() {
    jQuery('.menu-trigger').toggleClass('active');
});
jQuery('#mobile-toc-widget-wrap .ez-toc-list a').on('click', function() {
    jQuery('.menu-trigger').toggleClass('active');
});
jQuery('#drawer__input').on('click', function() {
    if (jQuery('#drawer__input').prop('checked')) {
        jQuery('#mobile-toc-widget-wrap').css('display', 'none');
    }else{
    jQuery('#mobile-toc-widget-wrap').css('display', 'block');
  }
});
jQuery('#mobile-toc-widget-wrap .ez-toc-list a').click(function() {
    if (jQuery('#mobile-toc-widget-wrap input').prop('checked')) {
        jQuery('#mobile-toc-widget-wrap input').prop('checked', false);
    }
});
jQuery(function () {
 var headerHight = 50; 
 jQuery('a[href^="#"]').click(function(){
     var href= jQuery(this).attr("href");
       var target = jQuery(href == "#" || href == "" ? 'html' : href);
        var position = target.offset().top-headerHight;
     jQuery("html, body").animate({scrollTop:position}, 550, "swing");
        return false;
   });
});

STEP5：ウィジェットを設定

外観→ウィジェットを開くと目次スマホ追尾という項目が増えているかと思います。

そこに目次のプラグインをいれてください。

TOC+をお使いの方は「TOC+」。

Easy Table of Contentsをお使いの方は「目次」。

タイトルは自由に変更してOKです。

以上で終了です！

リンク後に見出しと固定ヘッダーが被ってしまう人

全て終えたけど目次リンクを押したときに見出しがヘッダーの後ろに隠れてしまう人。

理想

現実

TOC+設定方法

TOC+の設定を変更していきます。

設定→TOC+で

「スムーズ・スクロール効果を有効化」にチェックを入れます。

上級者向け表示を開き、

「スムーズ・スクロール上部余白」を70px(ヘッダーの高さ)に変更すればOKです。

Easy Table of Contents設定方法

Easy Table of Contentsの設定を変更していきます。

設定→目次で

「モバイルのスムーズスクロールのオフセット」の数値を変更します。

入力した数値分下にズレるようになります。