Edited at

Google Chrome 拡張機能の開発 - 3 - 保存できるようにする

More than 1 year has passed since last update.

やりたいこと:データ保存を可能とし、ユーザーが任意にフォーマット形式を追加できるようにしたい

結論:データ保存は localStorage を使うだけ


//保存

localStorage.setItem(key, val);
//読み込み
hoge = localStorage.getItem(key);


追記[2016/01/07]:

この方法はあくまでHTML5の仕様を使ったもので、拡張機能で作っているのであればGoogoleのAPIを利用するのが望ましいようです。

第1回目で、概要が説明されていた記事を読み飛ばしていましたが、それなりに理解が深まった段階なので、記事を読み進めていって顔から火がでました。

とりあえず、いまはリンク先の記事をご覧ください。その内自分でも整理します。

Chrome拡張の開発方法まとめ その1:概念編 - chrome.storageAPIとOption Page



そこからつくったもの:今回の成果(サンプルコード)


はじめに

今回の記事は試行錯誤の様子などもありますので、コードの確認は一番下か上にある今回の結果のリンクをご利用ください。


前回の開発は・・・

Google Chrome 拡張機能開発の手始めとして、現在表示中のページのタイトルとURLをクリップボードに貼り付ける機能の拡張をしています。

最初はボタンを押して [タイトル](URL) の形式でコピー。続いて、ボタンを増やして、[URL:title=タイトル] の形式でコピーしました。


そして今

あるぇ~ 形式増えるたびにボタン増やすなんて。いやだぁ。

というわけなので、任意に追加できるようにしたくなりました。

となるとデータ保存の方法を知る必要があります。

手始めに、クリップボードへのコピー用に利用しているテキストエリアの文字列を保存できるようにすることからはじめてみます。

まずは popup.html に保存用のボタンを追加します。


追加部分のみ抜粋

<button id="Save">Save</button>


データの保存に関しては、HTML5でのlocalStorageを使えばいいみたいですね。いやぁ~便利なものですね。こうした機会にでも何か作らないと知りもしないもので。

さっそく、次のようにしてみます。


追加部分のみ抜粋

  $("#Save").on("click", function(){

localStorage.setItem("hoge", $("#text").val());
});
function hoge(){
$("#text").val(localStorage.setItem("hoge"));
}
hoge();

至って単純なはずなのに動きません。まったく原因がわからず、ログ出しなどで確認することにします。


ログ出力で確認

  $("#Save").on("click", function(){

console.log("ほげ - 01");
localStorage.setItem("hoge", $("#text").val());
});
function hoge(){
console.log("ほげ - 02");
$("#text").val(localStorage.setItem("hoge"));
}
hoge();

こんな感じで、ログ出力でそもそも動いているのかなど確認しようとしたら、ログも出ない。あれれのれぇ?? あぁもうなんなのさ。

どうやら拡張機能のログは別で確認しないといけないようですね。


[2016/01/06]追記:右クリックしてコンテキストメニューより[ポップアップを検証]で見れました。

image

以降のやり方は、まぁあれです。とりあえず出来るやり方でやっていたということで。


普通にhtmlファイルを開いて動かしてみることにします。

はい。ちゃんと出てました。HTML表示時ですね。

image

あっ。はい。setItemを呼んでいます。コピペ作業していたから気づかなかったのですね。超ウケるんですけど。

皆さんも気を付けてください。ここまでに、1時間ほど無駄にしちゃいました。

間違いを修正し、名称なども少し改めて、次のようなりました。


popup.html

Get Title&URL<br>

<button id="Qiita">Qiita</button><button id="はてな">はてな</button>
<textarea id="text"></textarea>
<button id="Save">Save</button>
<script src="jquery-3.1.1.min.js"></script>
<script src="./popup.js"></script>


popup.js

$(function(){

function copyText(val){
$("#text").val(val);
$("#text").select();
document.execCommand('copy');
}
$("#Qiita").on("click", function(){
chrome.tabs.getSelected(null, function(tab){
copyText("[{0}]({1})".replace("{0}", tab.title).replace("{1}", tab.url));
});
});
$("#はてな").on("click", function(){
chrome.tabs.getSelected(null, function(tab){
copyText("[{1}:title={0}]".replace("{0}", tab.title).replace("{1}", tab.url));
});
});
$("#Save").on("click", function(){
localStorage.setItem("text", $("#text").val());
});
function showSaveData(){
$("#text").val(localStorage.getItem("text"));
}
showSaveData();
});

動作確認です。まず普通に表示した状態です。

image

"ほげ"を入力して、Saveをクリックしました。

image

再度表示させてみます。ちゃんと"ほげ"が表示されました。やったね。

image

じゃぁちゃんと機能拡張しよう!


今回の成果(サンプルコード)

やりたいこと:リストボックスにフォーマット形式を追加・削除できて、選択している形式でコピーする

で、次のようになりました。


popup.html

<button id="Copy">Copy to Clipboard</button><br>

<select id="CopyFormat" size=5></select><br>
<textarea id="text"></textarea><br>
<button id="Add">Add</button> <button id="Delete">Delete</button> <button id="Save">Save</button><br>
<button id="Clear">Clear save data</button>
<script src="jquery-3.1.1.min.js"></script>
<script src="./popup.js"></script>


popup.js

const saveDataName = "SaveData";

$(function(){
//テキストエリアに文字列を貼りつけて、選択状態にしてクリップボードへコピーする
const copyText = (val)=>{
const txt = $("#text");
txt.val(val);
txt.select();
document.execCommand("copy");
}
//数値変換
//TODO: 配列要素の扱いで絶対にエラーを起こさないような対処が必要
const pi = (x)=>{
return parseInt(x.substr(1, x.length-2), 10);
}
//文字列フォーマット "{}"で囲われた範囲を中の数値と対応する配列の文字列で置き換え
//TODO: エスケープや例外への対処が必要
const formatString = (formatValue, replaceStringArray)=>{
formatValue.match(/({(\d)+})/g).forEach((x)=>{
formatValue = formatValue.replace(x, replaceStringArray[pi(x)]);
});
return formatValue;
}
//クリップボードへのコピーボタンクリック {0}:URL {1}:タイトル
$("#Copy").on("click", ()=>{
chrome.tabs.getSelected(null, function(tab){
copyText(formatString($("#CopyFormat > option:selected").text(), [tab.url, tab.title]));
});
});
//リストへの要素の追加
const addCopyFormat = (str)=>{
const list = $("#CopyFormat");
list.append($("<option>").text(str).val(list.children().length+1));
}
$("#Add").on("click", ()=>{
console.log($("#text").val());
addCopyFormat($("#text").val());
});
//リストへの要素の削除
$("#Delete").on("click", ()=>{
$("#CopyFormat > option:selected").remove();
});
//リストの内容を保存
$("#Save").on("click", ()=>{
let saveData = {"CopyFormat":[], "SelectedIndex":"1"};
console.log(saveData);
for (const option of $("#CopyFormat").children())
{
saveData.CopyFormat.push(option.text);
}
saveData.SelectedIndex = $("#CopyFormat").val();
localStorage.setItem(saveDataName, JSON.stringify(saveData));
console.log(saveData);
});
//設定データをクリアする
$("#Clear").on("click", ()=>{
localStorage.clear();
});
//保存データの読み込み
const loadData = ()=>{
const data = JSON.parse(localStorage.getItem(saveDataName));
console.log(data);
if (data == null){
//設定データがない場合、リストに初期値を指定
addCopyFormat("[{1}]({0})");
$("#CopyFormat").val("1");
} else {
data.CopyFormat.forEach((x)=>{ addCopyFormat(x); });
$("#CopyFormat").val(data.SelectedIndex);
}
}
loadData();
});

image


変更点


  1. 追加、削除、保存、セーブデータのクリアのボタンを追加

  2. 初期表示時は[タイトル](URL) の形式のみがリストに表示される

  3. [Add]で、テキストエリアに入力している内容をリストに追加

  4. [Delete]で、リストで選択している項目を削除

  5. [Save]でリスト内容を保存

  6. [Clear save data]で保存データ(localStorage)をクリアする。

jQueryは10年ぶり、Javascriptも2年ぶりくらいなので、コードがあれこれしているかもしれませんし、まだ例外の対処等していませんが、これで任意に形式を追加できるようになりました。

例えば、こんな感じで追加ができます。

imageimage


今回参考にした記事

以上

前回
一覧
次回

早速自作したものに機能追加していく
シリーズ一覧
マウスカーソルにある位置のものをコピー