3.app.json
{
"menu": "UPDATE LIBRARY",
"icon": "restore_page",
"note": "MPD command"
}
上記に11-update_libraryのapp.jsonを例示します。
本ファイルは JavaScript で使用される json 形式のデータです。
ただし、データの形式としてはオブジェクト型(記載の先頭と末尾が必ず {
, }
となり、これに囲まれた部分にキーと値を記録する)となります。
更にデータの記載方法を解説すると、値の定義(キーと値の組み合わせ)はキーの文字列、値の文字列を ”
(ダブルコーテーション)で囲み、キーと値の間にコロンを入力する形となります。
また、オブジェクト内の各行の最後には ,
を入れます。
app.jsonが使用するキーと記載文字列は以下の通りです。
キー | 値 |
---|---|
menu | Webuiのメニューや、プラグインの表題で表示される文字列を指定 |
icon | Webuiのメニューや、プラグインの表題で表示されるアイコンを指定(後述) |
note | PLUGINS プラグインで一覧表に表示されるプラグイン説明文字列をします。 |
※通常JavaScriptのプログラミングに使用されているJSON形式では自由にキーを設定可能だが、
Webui のapp.json(プラグイン説明用)としては menu, icon, note 以外のキー値は設定しても反映されない。
※iconで指定するアイコン文字列は以下の方法で特定する。
Google が提供する Material Icons で表示されているもので、
一覧画像に表示されたアイコンのうち希望のものをクリックするとウィンドウ右側にダイアログが表示されます。
このダイアログの「Icon font」欄に表示されるサンプルでspanタグに囲まれた文字列で指定します。
例えばSearchをクリックするとIcon fontのサンプル文字列は
<span class="material-icons">
search
</span>
と記載されているため、search
を指定します。