UserScriptの開発方法
当ページでは、UserScript(ユーザースクリプト)を自作しようとしている人に向けて、UserScript作成に必要な情報をまとめています。
UserScriptの適用方法等の基礎については UserScript(ユーザースクリプト)の概要と使い方 をご参照ください。
ヘッダ(メタ情報)UserScript特有の関数の利用例GM_addStyleGM_addElementcheckboxselect boxradioボタンGM_setClipboard便利なコードスニペット
ヘッダ(メタ情報)
UserScriptの始めには、以下のようなヘッダ(メタ情報)を記載します。
ヘッダはで囲います。
例:
各ヘッダの概要は以下の通りです。
ヘッダ名 | 説明 |
---|---|
@name | スクリプト名。 |
@namespace | スクリプトのネームスペース。 URLを指定すると、オプションページのスクリプト名にリンクされる。 |
@version | スクリプトのバージョン。 |
@author | スクリプト作成者名。 |
@description | スクリプトの概要。 |
@homepage | スクリプト作成者のホームページ。 指定されたURLはオプションページのスクリプト名にリンクされる。 |
@icon | スクリプトのアイコン。 |
@supportURL | スクリプトのサポートページのURL。 |
@match | スクリプトの適用対象サイト。 |
@exclude | スクリプトの適用対象外サイト。 |
@require | スクリプト実行前にロードするJavaScriptのURL。 |
@resource | 外部リソースのURL。 関数「GM_getResourceURL」と「GM_getResourceText」によって参照可能。 |
@run-at | スクリプト実行タイミング。 |
UserScript特有の関数の利用例
以降では、UserScript特有の関数について一部紹介します。
通常のJavaScriptでコードを書いても良いのですが、これらの関数を利用するとスッキリとしたコードを書くことが可能となります。
GM_addStyle
関数を利用すると、引数に指定したCSSを適用できます。
ヘッダにを追加する必要があります。
GM_addElement
関数を利用すると、HTMLの要素を追加できます。
第一引数に追加先の親要素を指定することもできます。
checkbox
select box
radioボタン
GM_setClipboard
クリップボードにテキストをコピーする機能です。
便利なコードスニペット
コンソール出力する機能。