レスポンシブWebデザインに対応のツールチップ用jQueryプラグインが良い感じ

  • 更新日:
  • 公開日:

パンくずナビゲーションや文字表示の無いアイコンボタンにはツールチップを使ったほうがユーザビリティが上がると思い、実装してみることにしました。

探すと色々出てくる中、レスポンシブに対応したツールチップ用のjQueryプラグインがあったのでご紹介します。導入も結構簡単です。

ツールチップ用のjQueryプラグイン

プラグインの名前は「Responsive and Mobile-Friendly Tooltip」。DEMOページはこちらになります。

使い方

ツールチップの表示は3つの手順で終わります。

  1. CSSの記述
  2. Javascriptの記述
  3. ツールチップを表示したい要素に専用の属性を付与

CSSの記述

以下のソースコードをCSSファイルに記述するか、<style></style>タグでHTMLに埋め込みます。

#tooltip
{
  text-align: center;
  color: #fff;
  background: #111;
  position: absolute;
  z-index: 100;
  padding: 15px;
}

#tooltip:after /* triangle decoration */
{
  width: 0;
  height: 0;
  border-left: 10px solid transparent;
  border-right: 10px solid transparent;
  border-top: 10px solid #111;
  content: '';
  position: absolute;
  left: 50%;
  bottom: -10px;
  margin-left: -10px;
}

#tooltip.top:after
{
  border-top-color: transparent;
  border-bottom: 10px solid #111;
  top: -20px;
  bottom: auto;
}

#tooltip.left:after
{
  left: 10px;
  margin: 0;
}

#tooltip.right:after
{
  right: 10px;
  left: auto;
  margin: 0;
}

 Javascriptの記述

以下のソースコードをJavascriptファイルに記述するか、<script></script>タグでHTMLに埋め込みます。jQueryライブラリより後に読み込むようにしないと動きません。

$( function()
{
    var targets = $( '[rel~=tooltip]' ),
        target  = false,
        tooltip = false,
        title   = false;
 
    targets.bind( 'mouseenter', function()
    {
        target  = $( this );
        tip     = target.attr( 'title' );
        tooltip = $( '<div id="tooltip"></div>' );
 
        if( !tip || tip == '' )
            return false;
 
        target.removeAttr( 'title' );
        tooltip.css( 'opacity', 0 )
               .html( tip )
               .appendTo( 'body' );
 
        var init_tooltip = function()
        {
            if( $( window ).width() < tooltip.outerWidth() * 1.5 )
                tooltip.css( 'max-width', $( window ).width() / 2 );
            else
                tooltip.css( 'max-width', 340 );
 
            var pos_left = target.offset().left + ( target.outerWidth() / 2 ) - ( tooltip.outerWidth() / 2 ),
                pos_top  = target.offset().top - tooltip.outerHeight() - 20;
 
            if( pos_left < 0 )
            {
                pos_left = target.offset().left + target.outerWidth() / 2 - 20;
                tooltip.addClass( 'left' );
            }
            else
                tooltip.removeClass( 'left' );
 
            if( pos_left + tooltip.outerWidth() > $( window ).width() )
            {
                pos_left = target.offset().left - tooltip.outerWidth() + target.outerWidth() / 2 + 20;
                tooltip.addClass( 'right' );
            }
            else
                tooltip.removeClass( 'right' );
 
            if( pos_top < 0 )
            {
                var pos_top  = target.offset().top + target.outerHeight();
                tooltip.addClass( 'top' );
            }
            else
                tooltip.removeClass( 'top' );
 
            tooltip.css( { left: pos_left, top: pos_top } )
                   .animate( { top: '+=10', opacity: 1 }, 50 );
        };
 
        init_tooltip();
        $( window ).resize( init_tooltip );
 
        var remove_tooltip = function()
        {
            tooltip.animate( { top: '-=10', opacity: 0 }, 50, function()
            {
                $( this ).remove();
            });
 
            target.attr( 'title', tip );
        };
 
        target.bind( 'mouseleave', remove_tooltip );
        tooltip.bind( 'click', remove_tooltip );
    });
});

 ツールチップを表示したい要素に専用の属性値を付与

CSS、Javascriptを記述したら準備はOKです。ツールチップを表示したい要素に「rel=”tooltip”」の属性値を加えます。そうすると、その要素の「title」属性に記述された文字がツールチップで表示されるようになります。

<a title="ツールチップだよ" rel="tooltip">ツールチップの例</a>

要素にツールチップ用の属性を追加するjQueryコード

おまけでこのツールチップ用の属性をjQueryで追加するソースコードを載せておきます。 CMSやブログサービス等を使っていて、コアファイルを弄らないと属性の追加が出来ない場合はこちらのソースコードで対応出来ます。

$(function () {
    $('#element a').attr({
        rel: "tooltip",
        title: "ツールチップだよ"
    });
});

2行目の「#element a」の部分に設定したい要素を指定し、4行目のtitleの値を任意の文字に変更します。 このソースコードはjQueryライブラリより後、ツールチップのソースコードよりも前に記述しないと動かないので注意して下さい。

2014年10月16日追記:

Twitterでご指摘をいただきました。

どうやらmouseentermouseleaveはスマホでうまく動作しないようです。iPhoneでしか確認せずに”スマホサイト”と書いてしまいました、勉強不足を痛感しています。タイトルから”スマホサイト”の文字を削除しました。

色々調べたところ、タッチ操作ではtouchleavetouchmoveといったイベントがあるようです。(参考: マウス・タッチ・ペンのタッチ操作イベント|Web制作 W3G

また、同じくこのプラグインを紹介している記事で言及されていることを引用します。

例えばPCサイトでマウスを乗せたらツールチップが出て、クリックするとリンクに飛ぶ、という箇所は、スマフォではタップすると先にツールチップが出てそのまま止まります。リンク先に飛ぶにはもう一度タップしなくてはなりません。ユーザーに「なぜリンク先に行かないの?」と思われてしまう可能性もあります。

レシポンシブWebデザイン対応のツールチップを実装するjQueryコード – かちびと.net

リンクにツールチップを付けてしまうと2回タップする必要が出てくるんですね。せっかくタップしてくれたのに「1回でリンク先に飛ばない」という通常ではない挙動のせいでページ移動を諦めてしまう可能性があります。なるべくリンクではなく補助機能として本当に説明が必要な箇所に付けたほうが良さそうです。

この指摘がなければ勘違いしたままでした。ありがとうございました。

書いた人

Symbol Mark

Ryoichi(しつ)

除菌ティッシュを買い込んで使いきれずによく乾かす人。

療養目的で退職し、どうやって生きていくか模索中。最近は勉強目的でLaravelやVue.js弄ったり、趣味で音で遊んでます。

※2019年10月16日現在ブログリニューアル中です。崩れなどが発生していたらすみません。

うぇぶ: @s_ryone