JavaScript

History API を「あらためて」使ってみる

以前、「History API を使ってみる」という記事を書いた。読み返したら非常に分かりにくかったため、History API の使い方をあらためて調べたので、自分なりの解を備忘録として残します。

サンプル:History API を「あらためて」使ってみる

ライブラリ

そもそも、便利なライブラリがすでにいくつか用意されている。

これらは、History API に対応していないブラウザでのケアや、ページ内に「戻る」「進む」ボタンを設置した場合の制御もケアされているようだ(使ったことはないです)。これはすごい。これらを使う。以上。

ではあるが、ここではライブラリを使わずに、もっとライトにシンプルにHistory APIを導入してみる。

ユーザーにやさしい

History API を使うメリットは、なんといってもユーザー体験が優れるということ。実際にページ遷移するわけではなく、「擬似的」に遷移させることが可能となり、ページ遷移することなくページURLが切り替わる。

たとえば、あたかもページが遷移したかのようで実はAjaxでの実装でページ遷移していない場合、前に戻ろうとブラウザや端末の「戻る」ボタンをクリック(タップ)すると想定外の画面が表示してしまうことがある。このようなとき、History API を用いることで擬似的にページ遷移したとみなすことができ、ブラウザや端末の「戻る」ボタンをクリック(タップ)しても期待する画面を表示させることができる。

History API

W3Cによる2015年7月17日時点での最新情報はこちら「Session history and navigation」。

一見、容易に実装ができる印象。だがしかし、実用レベルで考えた際、面倒なことがある。そこで、オリジナルのルールを決めることで、シンプルな実装をイメージしてみた。

3つの面倒なこと

  • History APIに対応していないブラウザ・端末がある
  • ファイル読み込み時に、popState(「進む」「戻る」をクリック(タップ)した際のイベント)を実行してしまうブラウザ・端末がある(想定外)
  • history.pushState(履歴を追加するメソッド) が使えても、history.state(履歴追加時にセットした情報) が使えない場合がある

オリジナルルール

面倒なことを避けるために、オリジナルルールを用いる。

  • History API に対応していないブラウザや端末はケアしない
  • ファイル読み込み時かどうかを判別する
  • history.state に対応していないブラウザや端末はケアしない(history.stateを使わずに処理できることもありケースバイケース。サンプルでは、history.state に対応していなくても、HIsotry APIを使う例を紹介)

実装イメージ

オリジナルルールを踏まえて用意したJavaScript。

JavaScript(jQueryを読み込み済みの場合)
var isHistoryPush = false;
function historyPushState(data, title, url) {
    if (history && history.pushState && history.state !== undefined) {
        history.pushState(data, title, url);
        isHistoryPush = true;
    }
}

function setHistory(func) {
    if (history && history.pushState && history.state !== undefined) {
        $(window).on('popstate', function(event){
        if (func && isHistoryPush) func(event.originalEvent.state);
    });
    }
}
JavaScript(jQueryを読み込んでいない場合)
var isHistoryPush = false;
function historyPushState(data, title, url) {
    if (history && history.pushState && history.state !== undefined) {
        history.pushState(data, title, url);
        isHistoryPush = true;
    }
}

function setHistory(func) {
    if (history && history.pushState && history.state !== undefined) {
        window.addEventListener('popstate',function(e){
            if (func && isHistoryPush) func(e.state);
        });
    }
}

使い方

History API を利用する場合は、setHistoryメソッドを実行する(setHistoryメソッドの引数にはブラウザ(端末)バックした際に実行するメソッド(メソッドA)をセット)。ちなみにメソッドAの引数には、historyPushStateを実行(履歴を追加)した際の第1引数がセットされる。

サンプル:History API を「あらためて」使ってみる

ざっくりポイント

History API を使えるか
if (history && history.pushState) {

    // 使えます
}
history.state に対応しているか
if (history && history.state !== undefined) {

    // 対応しています
}
history.stateについては、Android端末ではとくに、Android2.1以前、Android3.x, 4.0では未対応。history.state に対応していないらしい。とはいえ、端末依存の可能性も否めないため、単純にユーザーエージェント判別による振り分けは避けたい。あらゆる実機での検証は非現実的。とはいえ、history.stateを使わない実装であれば、この条件文は外してしまう(サンプルでは、history.state を使わない場合を用意してみた)。

サンプル:History API を「あらためて」使ってみる

ファイル読み込み時の処理かどうか
// jQuery読み込み済み
$(window).on('popstate', function(event){
    if (event.originalEvent.state && func) func(event.originalEvent.state);
});
// jQuery読み込みなし
window.addEventListener('popstate',function(e){
    if (e.state && func) func(e.state);
});
ファイル読み込み時かの判別として、event.originalEvent.state(e.state)に値があるか判別する方法を紹介する記事ばかりを見つけた。ただ、この方法には下記に注意する必要がある。

  • 履歴を追加後、ブラウザ・端末の「戻る」をクリック(タップ)して初期画面に戻った際に何も処理されない(ファイル読み込み時と同等の扱いとなる)
  • 履歴を追加する際、history.pushStateメソッドの第一引数を必須とする。この設定を行わないとブラウザ・端末の「進む」「戻る」をクリックしても画面の表示は変わらない(popstateが実行された際、event.originalEvent.state(e.state) が、nullとなるため)。

そこで、ファイル読み込み時のみの判別をするために、history.pushStateメソッド(履歴を追加するメソッド)が実行されたかの判別を行う。具体的には真偽値の変数(サンプルではとりあえず、isHistoryPushという変数名)を用意して判別を行う。

// jQuery読み込み済み
var isHistoryPush = false;
function historyPushState(data, title, url) {
    if (history && history.pushState && history.state !== undefined) {
        history.pushState(data, title, url);
        isHistoryPush = true;
    }
}

function setHistory(func) {
    if (history && history.pushState && history.state !== undefined) {
        $(window).on('popstate', function(event){
            if (func && isHistoryPush) func(event.originalEvent.state);
        });
    }
}

サンプル:History API を「あらためて」使ってみる

History API と SEO

ちなみにHistory API と SEOの関係はどうなるんだろうかと思ってググってみると、2014年3月に書かれたこんな記事が見つかった。

Googleジョン・ミューラー、新しいサイトには「#!」のAjaxよりも「HTML5のHistory API/pushState」を推奨 | 海外SEO情報ブログ

要は、設計次第。よくよく考えてみれば当たり前のことだったので、今にも通ずる内容で深く同意できた。

この記事の動作確認環境

jQueryを読み込み済みのサンプルで動作確認しました。

Windows8
IE11 Chrome43 Firefox38
Intel Mac OS X 10.x
Chrome43 Safari8 Firefox39
iPhone/Androidのデフォルトブラウザ
iPhone5S SC-06D SO-03D L-06D
iOS 8.0 Android 4.1.2 Android 4.0.4 Android 4.0.4

さいごに

結局のところ、2年以上前に書いた記事「History API を使ってみる」の焼き直しとなってしまった・・。結局のところ使い方はほぼ変わっていないというオチ。とはいえ、最新環境での動作確認とサンプルがより自分的にわかりやすくなったのでよしとします。

最近の記事

文章のユーザビリティ

この書籍の中で、ライティングのユーザビリティについて触れている項目があり、激しく共感する部分だったので、ここで備忘録としてピックアップする。 ・・・

ライティング

インタフェースデザイン

この書籍は、I部 リサーチ、II部 デザイン、III部 インプリメンテーションと三部構成になっている。この記事では、その中から、I部 リサーチ、・・・

デザイン思考

フルHD映像を4Kにする → スーパースケール

これを知ったときはマジか!と飛び跳ねた。あらためて思い返してみると、確かに公式チュートリアルでも触れていたことをうっすら思い出す。そしてそのときとやり方がなん・・・

DaVinci Resolve

Macで編集時と書き出し後で色味が変わってしまう場合に試してみたいこと

試したことはまだないけど、Macで編集時と書き出し後で色味が変わって困ったときのために備忘録。 プロジェクト設定 > 「カラーマネジメント・・・

DaVinci Resolve

プロジェクト設定と環境設定

プロジェクト設定と環境設定について詳しく解説されている情報がなかなか見つからないので、要所要所で知り得た情報を更新していきます。 プロジェクト設定 ・・・

DaVinci Resolve

項目”Clipy”は開いているため、ゴミ箱に入れることができません。←アンインストールしようとしたときの話し

Clipyが超絶便利そうだったので、macOS Big Sur にインストール&再起動して使ってみた。ところが、command + c を複数の箇所で行い、c・・・

徒然なままに

setTimeout は requestAnimationFrame に変えるべき?

requestAnimationFrame をはじめて見たので調べていたら、setTimeout や setInterval は requestAnimati・・・

JavaScript

書籍「小さなチーム、大きな仕事」からピックアップ

6年ぶりに読み返したが、今なおハッとさせられることが多く見つかる。 この本で忘れないようにしたい項目をピックアップするだけでも役に立ちそ・・・

起業向け情報

書籍「完全網羅 起業成功マニュアル」からピックアップ

この記事では、以前に読んだ際に付箋を付けていたが、その部分だけを備忘録としてピックアップするため、本の要約ではない。実際は、何倍も濃い内容で、練・・・

起業向け情報

書籍「はじめの一歩を踏み出そう」から気になったフレーズをピックアップ

もう一回、全部読み返したいところだが、書籍がありすぎるので、当時付箋紙をつけていたところだけをピックアップ。書籍内ではより具体的な説明があるので・・・

起業向け情報

人気の記事

ブラウザによるwidthプロパティの解釈の違い

正しいCSSを記述しているにもかかわらず、表示が崩れることがある。ブラウザによる解釈の違い(バグ)が原因であるが、IE5や古いブラウザにバグが見られる。・・・

CSS2007年1月1日

外付けハードディスクを起動ディスクにする

iBook G4(OS10.3.x)がある。Safariのバージョンは、1.xだ。2は10.4にしないと使えない。もっと詳しく言えば、10.4.10以下でないと・・・

お仕事・制作日記2008年9月8日

画面が縦向きか横向きかを知る

ブラウザ、モバイルファースト、メディアクエリー、マルチ画面、タブレット・・・ 想定すべき画面サイズ、利用シーンに適した情報のコントロールが崩壊しつつある。 とい・・・

JavaScript2012年11月12日

透明GIF画像の書き出し方法

たとえば、白文字が混じった画像を透明GIFにする場合、背景だけでなく白文字までが透明化されてしまう。 ずっと悩んでいたがようやく解決できたので覚え書き。 形・・・

Fireworks2008年7月11日

jQuery Mobileを使った最小ソース

jQurey Mobile。まもなくβ版がリリースされるそうですが、現状のα版3を見てみました。 最低限必要なソースまで削り落として、ちょっとjQuery Mo・・・

JavaScript2011年2月23日

ファイル名を拡張子なしで取得するサンプル

変数bnにphpファイルのファイル名を拡張子なしで取得するサンプル $bn = basename($_SERVER['PHP_SELF'], ".php");・・・

php2011年10月27日

Sassファイルを保存するとcssファイルが自動作成されて困る→サイト管理

sassファイルを保存すると、cssファイルが自動生成されるという症状でしばらくの間、ストレスだったがようやく解決。 例えば、var.scssを修正して保存す・・・

Dreamweaver2018年9月27日

文字コード変換

記述方法は間違いないのに、文字化けしてしまう。 xhtmlはutf-8で宣言していたのだが、Javascriptで記述された日本語がブラウザで確認すると文字化け・・・

Dreamweaver2007年12月9日

ファイル名を拡張子なしで取得するサンプル

変数bnにhtmlファイルのファイル名を拡張子なしで取得するサンプル var bn = location.href.split("/"); bn = bn[b・・・

JavaScript2011年10月27日

ローカル環境MAMPにWordPressをインストール

ローカル環境はMAMPを使いました。 データベースを作成する MAMPを起動し、「サーバを起動」後、「オープンWebStartの」をクリックします。 「ツ・・・

MAMP2015年2月5日

コメントありの記事

インタフェースデザイン

「test」

デザイン思考

Instagram API を使ってインスタに投稿した画像データを取得する

「>ころころさん コメントありがとうございます! 確かに、APIドキュメント見ましたが、ライブに関する情報は今のところ取得できないようですね。 インスタライ・・・」

API

Sony Eマウント フルサイズ対応のカメラレンズを収集するページを作ってみた

「SIGMAから超軽量で明るい単焦点レンズが2本発売になりましたので、リストにレンズ情報追加しました!」

お仕事・制作日記

overflowをautoにした要素のスクロール位置を変更する → scrollTop scrollLeft

「>名無しさん ご指摘、ありがとうございます! 記事冒頭の「まずはサンプル」のサンプルが動いていませんでしたので修正しました。」

JavaScript

えっ!?Yahooの検索結果から遷移しようとしたら全く違うサイトにリダイレクトされてしまった...

「>前田さん コメントありがとうございます。 環境は分かりかねますが、修正したいファイルのパーミッションを604や644に変更すると書き込みできるようになります(・・・」

お仕事・制作日記

記事の投稿IDなどの投稿者(ユーザー)情報を取得する方法 → get_the_author_meta

「アバターを取得する「get_avatar」についても追記しました!」

WordPress

jQueryでformを操る【nameの値を取得する/クリアする】

「「値をクリアする」を追加しました。チェックボックスやラジオボタンの値を何も選択していない状態に戻すときについて触れています。」

JavaScript

iframeの高さを自動調整する

「>匿名さん コメントありがとうございます。 サンプルでは、beforeは何も処理していないので期待する表示にならない、で正解です。 クリックした後が、対応・・・」

JavaScript

MAMPでMySQL Serverが突然起動しなくなった時 → ログファイル削除

「(匿名)さん コメントありがとうございます。何も設定変更していないのに、それまで使用できていたサーバーが突然使えなくなるのは辛いですよね、、。 ここで紹介したや・・・」

MAMP

イラストレーターでレイヤーごとにPNGで書き出す

「コメントありがとうございます! そもそもできるかはわかりませんが、ソースを書き換える必要はあります。 下記記事などが参考になるかもしれません。 illustra・・・」

Illustorator

WEB制作マークアップJavaScriptHistory API を「あらためて」使ってみる | シンプルシンプルデザイン