コラム:js-cookieの利用

目次

説明

『cookie』の利用は面倒なので、実はライブラリ(公開されている外部JavaScript)を使った方が楽です。

『js-cookie』は、『cookie』を手軽に扱うためのライブラリです。以下から入手できます。

『js-cookie』の利用

まず、『js-cookie』を外部JavaScriptファイルとして読み込みます。

<script src="js.cookie.js"></script>

基本的な使い方は、以下の通りです。『expires』などの設定は、引数のオブジェクトとして指定します。

【cookieの設定】

// cookieの設定 - 現在のサイト
Cookies.set('name', 'value');

// cookieの設定 - 期限7日、現在のサイト
Cookies.set('name', 'value', { expires: 7 });

// cookieの設定 - 期限7日、パス''(現在のページ)
Cookies.set('name', 'value', { expires: 7, path: '' });

【cookieの読み取り】

// cookieの読み取り
Cookies.get('name');     // 戻り値として「'value'」の文字列が得られる
Cookies.get('nothing');  // 未定義なので戻り値は「undefined」になる

// cookieの読み取り - 全て
Cookies.get();    // 戻り値として「{ name: 'value' }」のオブジェクトが得られる

【cookieの削除】

// cookieの削除
Cookies.remove('name');

// 現在のページにパスが設定されている場合は注意
Cookies.set('name', 'value', { path: '' });
Cookies.remove('name');    // 失敗する
Cookies.remove('name', { path: '' });  // きちんと削除できる