Deep Insider の Tutor コーナー
>>  Deep Insider は本サイトからスピンオフした姉妹サイトです。よろしく! 
jQuery Mobile逆引きリファレンス

jQuery Mobile逆引きリファレンス

jQuery Mobileページでヘッダー/フッターの表示をカスタマイズするには?

2014年1月30日

ヘッダー/フッターを作成する方法を解説。また、ヘッダー/フッターの位置を固定したり、タップで非表示にしたりする方法なども紹介。

  • このエントリーをはてなブックマークに追加

jQuery Mobileとは?

 jQuery Mobileは、jQueryを拡張するライブラリ(プラグイン)の一種で、名前のとおり、スマホ/タブレットに代表されるモバイル対応アプリを開発するための機能を提供します。jQuery Mobileの導入方法や使い方、jQuery Mobileが提供する主要機能については、「jQuery Mobile逆引きリファレンス: jQuery Mobileを利用するには?」を参照してください。

 jQuery Mobileでは、ページ要素の配下にdata-role属性がheader/footerである要素を配置することで、定型的なヘッダー/フッターを作成できます。別稿「jQuery Mobileで基本的なページを定義するには?」ではまず、テキストを配置しただけでしたが、一般的なヘッダー/フッターではアプリでよく使うボタン/リンクなどを配置するツールバーとしての役割を担います。

 本稿でも、最初にヘッダー/フッターにボタンを配置する方法を紹介した後、ヘッダー/フッターを位置固定したり、タップで非表示にしたりする方法などを紹介します。

ヘッダーにボタンを配置する

 ヘッダーにボタンを配置するには、以下のようなコードで表します。

HTML
<div data-role="page">
  <div data-role="header" data-theme="b">
     <a href="index.html" class="ui-btn ui-btn-a ui-btn-left">Home</a>
    <h1>jQuery Mobile TIPS</h1>
     <a href="help.htmll" class="ui-btn ui-btn-a ui-btn-right">About</a>
  </div>
  <div role="main" class="ui-content">
  ここが本文です。
  </div>
  <div data-role="footer">
    <h3>Copyright 1998-2014, YAMADA.Yoshihiro</h3>
  </div>
</div>
ヘッダーにボタンを配置した例(header.html)
ヘッダーにボタンを配置
ヘッダーにボタンを配置

 「class="ui-btn-left"」「class="ui-btn-right"」は、ボタンをそれぞれ「ヘッダーの左/右に配置しなさい」という意味です。jQuery Mobile 1.3以前ではボタンの配置順に応じて、自動的に左→右の順に配置されましたが、この挙動は1.4で非推奨となり、1.5で削除の予定です。配置位置は、class属性で明示的に示すようにしてください。

[Note]ボタンへの自動整形は利用しない

 もう1つ、jQuery Mobile 1.4で変更になった点があります。1.3以前では、ヘッダー/フッターに配置されたリンクは自動的にボタンとして整形されていましたが、その挙動は1.4で非推奨となり、1.5で削除となる予定です。今後、リンクボタンを作成したい場合には「class="ui-btn"」属性でスタイルを明示してください。

[戻る]ボタンを設置する

 前のページに戻るためのボタンを設置するならば、ヘッダー要素*1に対して「data-add-back-btn="true"」属性を付与します。

  • *1 1.3以前のバージョンでは、ページ要素に対して追加していました。
HTML
<div data-role="page">
  <div data-role="header" data-theme="b"
    data-add-back-btn="true" data-back-btn-text="戻る" data-back-btn-theme="a">
    <h1>jQuery Mobile TIPS</h1>
    <a href="help.htmll" class="ui-btn ui-btn-a ui-btn-right">About</a>
  </div>
  <div role="main" class="ui-content">
  ここが本文です。
  </div>
  <div data-role="footer">
    <h3>Copyright 1998-2014, YAMADA.Yoshihiro</h3>
  </div>
</div>
ヘッダー領域に[戻る]ボタンを設置(back.html)
[戻る]ボタンを設置
[戻る]ボタンを設置

 ただし、[戻る]ボタンはそのページに直接アクセスした場合、もしくは外部サイトからのリンクである場合には表示されませんので注意してください(=サイト内からのリンクである場合にのみ表示)。

 [戻る]ボタンのキャプションはdata-back-btn-text属性で、テーマはdata-back-btn-theme属性で、それぞれ変更できます。

[Note]アプリ共通で[戻る]ボタンを有効にするには?

 全てのページで[戻る]ボタンを有効にするならば、グローバル設定を利用するのが便利です。これには、mobileinitイベントリスナーに対して、以下のようなコードを追加してください。なお、mobileinitはjQuery Mobileを初期化する際に発生するイベントなので、「jQueryを読み込んだ後、jQuery Mobileを読み込む前」に登録しなければならない点に注意してください。

JavaScript
$(document).on('mobileinit', function() {
  $.mobile.toolbar.prototype.options.addBackBtn = true;
  $.mobile.toolbar.prototype.options.backBtnText = '戻る';
  $.mobile.toolbar.prototype.options.backBtnTheme = 'a';
});
[戻る]ボタンを有効にするためのコード(back.js)

 ちなみに、jQuery Mobile 1.3以前は[戻る]機能はPageウィジェットに属していましたが、1.4でToolbarウィジェットに移動となっています。よって、1.3以前では太字の部分は「page」と置き換えてください。

フッターにボタンを配置する

 以下はフッターにボタンを配置するコードと実行例です。フッターに配置したボタンは、デフォルトで、左詰めで配置されます。

HTML
<div data-role="page">
  <div data-role="header" data-theme="b">
    <h1>jQuery Mobile TIPS</h1>
  </div>
  <div role="main" class="ui-content">
  ここが本文です。
  </div>
   <div data-role="footer" data-theme="b" class="ui-bar">
    <a href="index.html" class="ui-btn ui-btn-a">Home</a>
    <a href="config.html" class="ui-btn ui-btn-a">Config</a>
    <a href="about.html" class="ui-btn ui-btn-a">About</a>
   </div>
</div>
フッターにボタンを配置する例(footer.html)
フッターにボタンを配置
フッターにボタンを配置

 ただし、デフォルトの状態ではボタンの周囲にパディングが設定されていないことから、心持ち詰まったレイアウトとなります。これを避けるためには、フッター要素に対して「class="ui-bar"」属性を付与することで、ツールバーの表示に適した余白が付与されます。

ヘッダー/フッターを位置固定する

 ヘッダー/フッターに配置するボタンは、大概、ツールバー/ナビゲーションバーとしての役割を担うもので、いつでもすぐさまにアクセスできることを求められます。よって、ヘッダー/フッターにボタンを配置した場合には位置を固定し、ページのスクロールによってヘッダー/フッターが上下に流れてしまわないようにすべきです。

 これには(次のコードのように)、ヘッダー/フッター要素に対して「data-position="fixed"」属性を付与するだけです。

HTML
<div data-role="page">
  <div data-role="header" data-position="fixed" data-fullscreen="true"
    data-theme="b">
    ……中略……
  </div>
  <div role="main" class="ui-content">
    ……中略……
  </div>
  <div data-role="footer" data-position="fixed" data-fullscreen="true"
    data-theme="b" class="ui-bar">
    ……中略……
  </div>
</div>
ヘッダー/フッターを位置固定する例(fixed.html)
ページをスクロールしてもヘッダー/フッターは動かない

ページをスクロール

ページをスクロールしてもヘッダー/フッターは動かない
ページをスクロールしてもヘッダー/フッターは動かない

 「data-fullscreen="true"」属性は、位置固定したヘッダー/フッターの表示を、画面タップによって非表示にできることを意味します(フルスクリーンモード。次の画面はその例)。これによって、限られた画面領域を最大限活用できます。写真など、コンテンツの表示を主目的とするアプリでは、フルスクリーンモードを有効にしておくことをお勧めします。

画面タップでヘッダー/フッターを非表示に

画面の本文などをタップ

画面タップでヘッダー/フッターを非表示に
画面タップでヘッダー/フッターを非表示に

ツールバーを永続化する

 ページ間で、ヘッダー/フッター要素にアプリ共通のdata-id値を付与しておくことで(次のコードを参照)、ページを遷移する間も、ヘッダー/フッターをそのままにコンテンツだけを書き換えられます(永続化ツールバー)。これによって、ページの移動中もボタン操作などを継続して行えますので便利です。永続化ツールバーを有効にするには、対象のヘッダー/フッターを位置固定しておくようにしてください。

HTML
<div data-role="page">
  <div data-id="common_header" data-role="header"
   data-position="fixed" data-fullscreen="true" data-theme="b">...</div>
  <div role="main" class="ui-content">...</div>
  <div data-id="common_footer" data-role="footer"
    data-position="fixed" data-fullscreen="true"
    data-theme="b" class="ui-bar">...</div>
</div>
ヘッダー/フッターを共有したいページで共通のid値を付与(fixed.html/fixed2.html)
ページ移動時もヘッダー/フッターは固定

[次のページへ]ボタンをタップしてページ遷移

ページ移動時もヘッダー/フッターは固定
ページ移動時もヘッダー/フッターは固定

※以下では、本稿の前後を合わせて5回分(第1回~第5回)のみ表示しています。
 連載の全タイトルを参照するには、[この記事の連載 INDEX]を参照してください。

jQuery Mobile逆引きリファレンス
1. jQuery Mobileを利用するには?

jQuery Mobileの基本機能を目的別リファレンスの形式でまとめる連載スタート。jQuery Mobileが動作するスマホ/タブレット環境と、jQuery Mobileページの基本構造を説明する。

jQuery Mobile逆引きリファレンス
2. jQuery Mobileで基本的なページを定義するには?

基本的なページを作成する方法を解説。要素のid値を振る際の注意点と、1つのファイルで複数ページを管理する方法についても説明。

jQuery Mobile逆引きリファレンス
3. jQuery Mobileのテーマを設定(&ThemeRollerによる自作テーマ作成)するには?

サイトデザインを管理できる「テーマ」と「スウォッチ」の基本的な利用法を解説。

jQuery Mobile逆引きリファレンス
4. 【現在、表示中】≫ jQuery Mobileページでヘッダー/フッターの表示をカスタマイズするには?

ヘッダー/フッターを作成する方法を解説。また、ヘッダー/フッターの位置を固定したり、タップで非表示にしたりする方法なども紹介。

jQuery Mobile逆引きリファレンス
5. jQuery Mobileページでハイパーリンクを設置するには?

jQuery Mobileにおけるリンクの挙動を解説。また、ページ遷移時のエフェクトやプリフェッチ機能についても説明する。

サイトからのお知らせ

Twitterでつぶやこう!