JavaScript

History API を使ってみる

この記事を、下記ページに焼き直しました。
History API を「あらためて」使ってみる
2015.7.21

History API を使ってみたので備忘録。

実際にページ遷移することなくURLを変更できる

HTML5の中でよく取り上げられる話題の一つ、History API。
そもそもhistory自体は新しいものではなく、history.back()とかで馴染みがある(詳細:W3C)。
その中の history.pushState を使うことで「実際にページ遷移することなく、URLを変更できる」ようになった。

使いどころとしては、たとえば、サイト内遷移において、ページ全体を呼び出さずにメイン部分のコンテンツを差し替えることができたり、ぐるめAPIなど外部APIをある条件で呼び出したとき、その条件を保持したURLを生成することで、ブラウザバックを押したときは、その検索結果に戻ることができる。

ちょっとした気遣いだが、画面表示において体感速度向上!UXアップ!!

気をつけるべき点は3つ。

  • 変更後のURLを直で入力すると、表示変更後の内容が再現されるか
  • ブラウザバックした際に、変更前の内容に復元されるか
  • History API が使用できない環境のケア

変更後のURLを直で入力すると、表示変更後の内容が再現されるか

変更したURLでページ遷移しても、同様の内容が表示されるページに遷移するか、と置き換えることができる。

変更したURLを直でたたくとページの内容が変わったり、ページの一部のみが表示されてしまうのはUX的によろしくないので、個人的には対応必須だと思ってます。

ブラウザバックした際に、変更前の内容に復元されるか

ブラウザバックした際、URLが変更されているのにコンテンツに変化がないのは違和感を感じます。個人的には対応必須かと思います。

History API が使用できない環境のケア

History APIを導入する際はページ遷移できることが大前提。でもHistory APIを使うことでUX向上できる。というスタンスでコンテンツ制作する使い方をこころがけたい。
実際、IE9以下ではhistory.pushStateに未対応だったりするので、History API ありきでのコンテンツ作成は現時点(2013年2月現在)ではNGですね。

と前置きが長くなりましたが、サンプルです。

サンプル: History API を使ってみる 1

history.pushState(data, title [, url ] )

実用的ではありませんが、理解のため、「URL更新」のクリックすると、クリックした日時をURLにセットし、そのセットしたURLをタイトルに表示するサンプルを作ってみました。
対象外端末では、「history api を使うことができません。」を表示するようにしました。

html
<h1 id="h1">history api を使ってみる</h1>
<p><a href="#" onclick="setHistoryApi();return false;">URL更新</a></p>
JavaScript

// ヒストリー後、もしくはbackボタン後 function getHistoryApi(p, s){ document.getElementById('h1').innerHTML = p + s; }

// ヒストリーする function setHistoryApi(){ // history api が使えるか判別 if (history && history.pushState) { var t = new Date().getTime(); var p = location.pathname; var s = '?time=' + t; getHistoryApi(p, s); history.pushState(t, document.title, p + s);} else { document.getElementById('h1').innerHTML = 'history api を使うことができません。'; } }

// backボタンで復元 window.addEventListener('popstate', function(){ getHistoryApi(location.pathname, location.search); }, false);

サンプル:History API を使ってみる 1

これで問題なし、といきたいところだったのですが、Windows7のChrome 18.0.2 / Opera 5.1.7 で検証した際、ファイル呼び出し時に、popStateが実行されることが判明しました。ちょっとこれは想定外だったので、もうちょっとJavaScriptを改修します。

今のところのベスト: History API を使ってみる 2

「ファイル呼び出し直後ではない場合、もしくはセットしようとしているURLが現在のページと異なる場合」という判別を入れることで、ファイル呼び出し時に、popStateが実行されないようケアします。

もっといい方法あるはずですが・・・

JavaScript
// ヒストリー後、もしくはbackボタン後
var flag_history = false;
function getHistoryApi(p, s){
if (p != location.pathname || s != location.search || flag_history) {
document.getElementById('h1').innerHTML = p + s;
}
flag_history = true;
}
// ヒストリーする
function setHistoryApi(){
// history api が使えるか判別
if (history && history.pushState) {
var t = new Date().getTime();
var p = location.pathname;
var s = '?time=' + t;
getHistoryApi(p, s);
history.pushState(t, document.title, p + s);
} else {
document.getElementById('h1').innerHTML = 'history api を使うことができません。';
}
}
// backボタンで復元
window.addEventListener('popstate', function(){
getHistoryApi(location.pathname, location.search);
}, false);

サンプル:History API を使ってみる 2

最近の記事

インタラクションデザイン

5年くらい前に購入した書籍「インタラクションデザイン」。この書籍内ではたくさんの事例が紹介されている。残念ながらその多くは現在閲覧することができなくなっていた・・・

デザイン

Advanced Custom Fields 名前を変更して、データも反映させる

WordPressを自作する上でもはや欠かせないプラグインの一つが、「Advanced Custom Fields」。 名前を変更しようと思って、Wor・・・

WordPress

配列の重複を削除する

配列の場合 /** * 配列の重複を削除する * * @param {array} ary* * @return {array} 処理後のary・・・

JavaScript

MAMP を 5.7 から 6.2 にアップデートした

5年以上前と比べると、アップデートが簡単で驚く。とくに記事にするまでもないと思いつつ、一応備忘録。 インストールすると、既存のディレクトリはそのままに別・・・

MAMP

Briefly unavailable for scheduled maintenance. Check back in a minute. → . maintenance を削除

プラグインを更新中に、誤って、違うページにアクセスしまいました。すると、管理画面だけでなく、公開中のすべての画面が「briefly unavailable f・・・

WordPress

GulpでERRが出てテンパった → gyp: No Xcode or CLT version detected! → PostCSS plugin autoprefixer requires PostCSS 8

Gulp。いつもは正常に動いている環境をそのままコピーして再利用するようにしている。そうすることで、案件ごとに毎回環境作りをする手間を省くことができ、何よりG・・・

制作効率化

ビジネス前提ワークシート

書籍「LEAN UX リーン思考によるユーザエクスペリエンス・デザイン」から抜粋。 「前提の宣言」「MVPの作成」「実験の実行」「フィードバックとリサー・・・

知識編

リーン思考のUXデザイン

LEAN UX は、コラボレーションと部門/領域横断的な手法によって、製品の本質を素早く明らかにするための実践的手法であり、これによって文書への過度な依存を減・・・

知識編

ES6(ES2015)の主な変更点

オブジェクト指向 クラス定義 JavaScriptは厳密にはクラスがない、プロトタイプベースのオブジェクト指向言語。ES6でclass構文が導入さ・・・

JavaScript

JavaScriptスタイルガイド

書籍「メンテナブルJavaScript」と Google JavaScript Style Guide 和訳 を参考に自分なりのJavaScriptスタイルガ・・・

JavaScript

人気の記事

WP_Queryを使って絞り込み検索するのにコレは便利!

めっちゃ参考になるページを見つけた。 絞り込みをするたびに色々ググっていたが、これがあればほとんどのことが解決できそうな気がする。 参考: これは便利!Word・・・

WordPress

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

まずはサンプル。 これは、overflowをautoにした要素のスクロール位置を変更するサンプルです。 これは、overflowをautoにした要素のスクロ・・・

JavaScript

http://localhost:8888/ → http://localhost/

http://localhost:8888/ での参照ではなく、http://localhost/ で参照できるようにします。 MAMPの設定を変更する M・・・

MAMP

iframeの高さを自動調整する

iframeで呼び出した際、iframe自体はスクロールさせずに高さを取得してiframe全体を表示させます。 サンプル:iframeの高さを自動調整するデモ・・・

JavaScript

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

【2020年07月13日】 macOS Catalina(10.15.5) / Adobe iLLustrator 2020(24.2.1) にて動作確認済・・・

Illustorator

アーカイブページでカスタムフィールドやタクソノミーで絞り込みした状態でリスト表示する

<?php $args = array( 'paged' => 1, 'posts_per_page' => 20, 'post・・・

WordPress

WordPressのカテゴリー一覧ページでカテゴリー名とスラッグを取得する → get_queried_object()

やりたいこと カテゴリー一覧ページで、そのカテゴリー一覧ページに属する記事一覧を取得するためにループさせるのとは別に、タイトルやカテゴリー別にデザインを変・・・

WordPress

MAMPの日時(タイムゾーン)を変更する

MAMPを使用していて、日時の情報を制御しようとしたとき、取得している日時が日本時間ではないことに気がついた。 時差を計算してPHPでプログラミングしていたが、・・・

MAMP

カウントアップ、カウントダウンするJavaScript

ポイントを使ったり、増やしたりしたときに、結果のポイント数に差し替えるのではなくて、カウントアップしたり、カウントダウンして動的に動かそうと思って作ってみた。・・・

JavaScript

管理画面のカスタム投稿一覧で並び順を変更する

WordPressの管理画面。「投稿」や「固定ページ」の一覧は、公開日順に並んでいる。ところが、カスタム投稿を追加した場合、公開順ではなく名前順に並んでいること・・・

WordPress

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