索引

188 ページあります:

# ページ タグと要約
1 ブラウザー拡張機能 Add-ons, Extensions, Landing, WebExtensions
拡張機能はブラウザーの能力を拡張・修正するものです。Firefox の拡張機能は WebExtensions API を使ってビルドされ、この API は拡張機能をクロスブラウザーで開発するシステムです。
2 ツールバーにボタンを追加する WebExtensions
ツールバーボタンは拡張機能で利用できる主な UI コンポーネントです。ツールバーボタンはブラウザーツールバーに存在してアイコンを含んでいます。ユーザーがアイコンをクリックした時、下記の 2 つのいずれかが起こります:
3 拡張機能の中身 WebExtensions
拡張機能は複数のファイルで構成されており、それらのファイルが配布・インストール用にパッケージ化されたものです。この記事では、拡張機能に含まれるファイルについて簡単に説明します。
4 JavaScript API 群 WebExtensions
WebExtension 用の JavaScript API は拡張機能のバックグラウンドスクリプトと、その他の拡張機能にバンドルした文書 (ブラウザーアクションページアクションポップアップやサイドバーオプションページ新規タブページを含む) で使用できます。いくつかの API は拡張機能のコンテンツスクリプトからもアクセスできます (コンテンツスクリプトガイドの表を見てください)。
5 alarms
コードが動作するタイミングを予約します。この API は setTimeout()setInterval() と似ていますが、 alarms API はバックグラウンドで動作する点が異なります。
6 alarms.Alarm API, Add-ons, Extensions, Non-standard, Reference, Type, WebExtensions, alarm, alarms
単一のアラームに関する情報を含みます。このオブジェクトは alarms.get()alarms.getAll() の戻り値として返されます。また、alarms.onAlarm リスナに渡されることもあります。
7 alarms.clear() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, clear
与えた名前に対応するアラームを解除します。
8 alarms.clearAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, clearAll
予約されたアラームすべてを解除します。
9 alarms.create() API, Add-ons, Create, Extensions, Method, Non-standard, Reference, WebExtensions, alarms
新しいアラームを生成します。
10 alarms.get() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, get
与えた名前に対応するアラームを取得します。取得したアラームは、コールバック関数に渡す alarms.Alarm オブジェクトとして用いることがあります。
11 alarms.getAll() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, alarms, getAll
予約されたアラームすべてを取得します。取得されたアラームは alarms.Alarm オブジェクトの配列としてコールバック関数に渡されます。
12 alarms.onAlarm API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, alarms, onAlarm
アドオンによってアラームが動作した際に発火します。
13 bookmarks API, Add-ons, Bookmarks, Extensions, Interface, Non-standard, Reference, WebExtensions
WebExtensions bookmarks API を利用すると、拡張機能からブラウザーのブックマークシステムにアクセスしたり、操作することができます。ページをブックマークしたり、既存のブックマークを取得したり、ブックマークを編集・削除・整理することが可能です。
14 bookmarks.BookmarkTreeNode API, Add-ons, BookmarkTreeNode, Bookmarks, Extensions, Non-standard, Reference, Type, WebExtensions
bookmarks.BookmarkTreeNode 型のオブジェクトは、ブックマークツリー上のノード(ブックマーク / フォルダ)を表現するものです。子ノードは親フォルダの中で index に従って順序付けされます。
15 bookmarks.BookmarkTreeNodeType API, Add-ons, BookmarkTreeNodeType, Bookmarks, Extensions, Property, Reference, WebExtensions
bookmarks.BookmarkTreeNodeType 型は、ブックマークツリーのノードがブックマーク、フォルダーまたはセパレーターであるかどうかを示すために使用されます。
16 bookmarks.BookmarkTreeNodeUnmodifiable API, Add-ons, BookmarkTreeNodeUnmodifiable, Bookmarks, Extensions, Non-standard, Reference, Type, WebExtensions
bookmarks.BookmarkTreeNodeUnmodifiable 型は、ブックマークツリー上のノード(ブックマーク / フォルダー)が変更不可な理由を表すものです。この型は、ブックマークノードの bookmarks.BookmarkTreeNode プロパティで使用されます。
17 bookmarks.create() API, Add-ons, Bookmarks, Create, Extensions, Method, Non-standard, Reference, WebExtensions
bookmarks.create() は、parentId で指定した bookmarks.BookmarkTreeNode の配下に、ブックマークやフォルダを作成するメソッドです。フォルダを作成する場合は、bookmarks.CreateDetails の引数を省略するか空にします。
18 bookmarks.CreateDetails API, Add-ons, Bookmarks, CreateDetails, Extensions, Non-standard, Reference, Type, WebExtensions
CreateDetails 型は、新しいブックマークやフォルダのプロパティを表すためのオブジェクト型です。bookmarks.create() メソッドの呼び出し時に渡します。
19 bookmarks.get() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, get
bookmarks.get() は、指定した bookmarks.BookmarkTreeNode の ID(または ID の配列)にマッチするノードを取得するメソッドです。
20 bookmarks.getChildren() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getChildren
bookmarks.getChildren() は、ブックマークフォルダの ID を bookmarks.BookmarkTreeNode で指定し、その直下にあたる子要素をすべて取得します。
21 bookmarks.getRecent() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getRecent
bookmarks.getRecent() は、最近に追加されたブックマークを指定した最大個数まで取得し、bookmarks.BookmarkTreeNode オブジェクトの配列としてコールバック関数に渡します。
22 bookmarks.getSubTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getSubTree
bookmarks.getSubTree() は、ID を指定して bookmarks.BookmarkTreeNode を非同期に取得するメソッドです。
23 bookmarks.getTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, getTree
bookmarks.getTree() は、ブックマークツリーのルートを表したbookmarks.BookmarkTreeNode オブジェクトの配列を返します。
24 bookmarks.move()
bookmarks.move() は、指定した bookmarks.BookmarkTreeNode をブックマークツリー内の所望の位置に移すメソッドです。このメソッドにより、ブックマークを新しいフォルダの中や、同じフォルダ内の別の場所に移動させることができます。
25 bookmarks.onChanged API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onChanged
以下の変更に対して発火します。
26 bookmarks.onChildrenReordered API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onChildrenReordered
UI で表示されている順序に伴って子フォルダの順序も変更された際に発火します。bookmarks.move() の実行後や、UI におけるドラッグの際には発火しません。
27 bookmarks.onCreated API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onCreated
ブックマークやフォルダが作成された際に発火します。
28 bookmarks.onImportBegan API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onImportBegan
ブックマークのインポートが開始した際に発火します。
29 bookmarks.onImportEnded API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onImportEnded
ブックマークのインポートが終了した際に発火します。
30 bookmarks.onMoved API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onMoved
ブックマークやフォルダが、異なる親フォルダやフォルダ内の別の場所へ移された際に発火します。
31 bookmarks.onRemoved API, Add-ons, Bookmarks, Event, Extensions, Non-standard, Reference, WebExtensions, onRemoved
ブックマークやフォルダが削除された際に発火します。フォルダが再帰的に削除された場合は、そのフォルダに対して 1 回だけ発火し、そのフォルダの中身に関しては発火しません。
32 bookmarks.remove() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, remove
bookmarks.remove() は、ブックマークや空のブックマークフォルダを削除するメソッドです。
33 bookmarks.removeTree() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, WebExtensions, removeTree
bookmarks.removeTree() は、ブックマークフォルダやその要素を再帰的に削除するメソッドです。
34 bookmarks.search() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, Search, WebExtensions
bookmarks.search() 関数は、指定したクエリにマッチするブックマークを検索するものです。マッチしたブックマークは、bookmarks.BookmarkTreeNode オブジェクトの配列として、指定されたコールバック関数の引数に渡されます。
35 bookmarks.update() API, Add-ons, Bookmarks, Extensions, Method, Non-standard, Reference, Update, WebExtensions
bookmarks.update() は、ブックマークの URL やタイトル、またはフォルダの名前を更新するメソッドです。
36 browserAction API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, browserAction
ブラウザーのツールバーにボタンを追加します。
37 browserAction.ColorArray
RGBA色を定義する、4つの0から255の整数の配列です。4つの値は以下のチャネルを指定します:
38 browserAction.disable()
タブに対してブラウザアクションを無効にします。つまり、タブがアクティブな時クリックされなくなります。
39 browserAction.onClicked
ブラウザアクションアイコンがクリックされたときに発火します。このイベントはブラウザアクションがポップアップを持っているときは発火しません。
40 browserSettings API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, browserSettings
この API を使うには "browserSettings" パーミッションが必要です。
41 browserSettings.newTabPageOverride
types.BrowserSetting オブジェクトを使用すると「新規タブ」ページ、つまりユーザーが新しい空のタブを開いたときのページを表すURLを取得することができます。
42 browsingData Add-ons, Extensions, Non-standard, Reference, WebExtensions, browsingData
 browsingData APIでは、ブラウズデータは下記の型に分けられます:
43 browsingData.removeCache() API, Add-ons, Extensions, Method, Reference, WebExtensions, browsingData, removeCache
ブラウザのキャッシュを消去します。
44 clipboard API, Add-ons, Clipboard, Extensions, Reference, WebExtensions
クリップボード API は、拡張機能がシステムのクリップボードに要素をクリップするのを可能にします。現在この API は画像のコピーだけをサボートしていますが、将来的にはテキストとHTMLのコピーをサボートする計画です。
45 clipboard.setImageData()
イメージをクリップボードにコピーします。イメージはクリップボードに書き込まれる前に再エンコードされます。イメージが無効な場合、クリップボードは修正されません。
46 commands API, Add-ons, Extensions, Reference, WebExtensions, commands
commands manifest.json キーを使って、登録したコマンドをユーザーが実行するのをリッスンします。
47 contentScripts API, Extensions, Interface, WebExtensions, contentScripts, インタフェース, コンテントスクリプト, 拡張機能
一方content_scripts APIは、ランタイム(実行時)でスクリプトを登録・登録解除することが可能です。
48 contentScripts.register() API, Extensions, Method, Reference, contentScripts, register
このメソッドは一つ以上の content scripts を登録するときに使用します。
49 contextualIdentities WebExtensions
contextual identitiesの操作: contextual identities を一覧、作成、削除、更新します。
50 cookies API, Add-ons, Cookies, Extensions, Interface, Reference, dard
拡張機能に cookie の取得と設定と、変更された時の通知を可能にします。
51 cookies.Cookie API, Add-ons, Cookies, Extensions, Non-standard, Reference, Type, WebExtensions, cookie
cookies API の Cookie 型はHTTP cookie の情報を持ちます。
52 downloads API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, downloads
拡張機能にブラウザーのダウンロードマネージャーとのやりとりを可能にします。このAPI モジュールを、ファイルマネージャーでのファイルのダウンロード、キャンセル、停止、ダウンロードの再開、ダウンロード済みのファイルの表示に使用できます。
53 downloads.download()
downloads API の download() 関数ではURLとそのほかのオプションの設定を行うことでファイルのダウンロードをすることができます。
54 events API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, events
イベントをディスパッチする API から使われる共通の型です。
55 extension API, Add-ons, Extension, Extensions, Interface, Non-standard, Reference, WebExtensions
拡張機能に関連するユーティリティ。拡張機能のリソースパッケージのURLを取得したり、拡張機能のページの Window オブジェクトを取得したり、いろいろな設定の値を取得したりします。注意として、このモジュールのメッセージ APIs は非推奨で、 runtime モジュールの同様な API が好まれます。
56 extensionTypes API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, extensionTypes
その他の WebExtension API で使われる共通な型
57 extensionTypes.ImageDetails API, Add-ons, Extensions, ImageDetails, Non-standard, Reference, Type, WebExtensions, extensionTypes
画像のフォーマットと品質に関する詳細。
58 extensionTypes.RunAt API, Add-ons, Extensions, Non-standard, Reference, RunAt, Type, WebExtensions, extensionTypes
JavaScript や CSS がどの時点でタブに挿入されるか。
59 find API, Add-ons, Extensions, Reference, WebExtensions, find
ウェブページのテキストを検索し、マッチしたものをハイライトします。
60 find.find()
テキストによるタブ内の検索をします。
61 history API, Add-ons, Extensions, History, Interface, Non-standard, Reference, WebExtensions
ブラウザー履歴とやりとりする history API を使用します。
62 history.HistoryItem API, Add-ons, Extensions, History, HistoryItem, Non-standard, Reference, Type, WebExtensions
HistoryItem オブジェクトはブラウザー履歴でのページ情報を提供します。
63 i18n API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, i18n
拡張機能を国際化する関数です。これらの API は、拡張機能に同梱したロケールファイルからローカライズ文字列を取得したり、ブラウザーの現在の言語や、その Accept-Language ヘッダー を調べるために使用します。
64 i18n.detectLanguage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, detectLanguage, i18n
提供されたテキストの言語を Compact Language Detector (CLD) を利用して検出します。
65 i18n.getAcceptLanguages() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getAcceptLanguages, i18n
ブラウザーの accept-languages を取得します。これは、ブラウザーに使用されているロケールとは異なります。ロケールを取得するには、i18n.getUILanguage を使用してください。
66 i18n.getMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getMessage, i18n
指定したメッセージのローカライズされた文字列を取得します。
67 i18n.getUILanguage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, getUILanguage, i18n
ブラウザーの UI 言語を取得します。これは、優先されるユーザー言語を返す i18n.getAcceptLanguages とは異なります。
68 i18n.LanguageCode API, Add-ons, Extensions, LanguageCode, Non-standard, Reference, Type, WebExtensions, i18n
"en-US" や "fr" などの 言語タグ
69 ロケール固有のメッセージ参照 Internationalization, Localization, Reference, String, WebExtensions, i18n, message, message.json, placeholders
国際化対応 (i18n) した拡張機能は、ロケール固有のメッセージを提供する少なくとも 1 個の messages.json というファイルを持っています。このページでは、messages.json の書式を説明します。
70 identity API, Add-ons, Extensions, Identity, Reference, WebExtensions
identity API を使って OAuth2 の認証コードやアクセストークンを取得し、拡張機能が OAuth2 での認証 (Google や Facebook アカウントなど) をサポートするサービスからユーザーデータを取得できるようにします。
71 identity.getRedirectURL() API, Add-ons, Extensions, Identity, Method, Reference, WebExtensions, getRedirectURL
リダイレクト URL として利用可能な URL を生成します。
72 idle API, Add-ons, Extensions, Idle, Interface, Non-standard, Reference, WebExtensions
ユーザーのシステムがアイドル状態、ロックされた状態、アクティブな状態であるのを発見します。
73 management API, Add-ons, Extensions, Reference, WebExtensions, management
インストール済みのアドオンの管理情報を取得します。
74 menus API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, contextMenus, menus
ブラウザーのメニューシステムに項目を追加します。
75 menus.onClicked
メニューアイテムがクリックされたときに発火します。
76 notifications API, Add-ons, Extensions, Notifications, WebExtensions
OS の通知メカニズムを使って、ユーザーへの通知を表示します。この API は OS の通知メカニズムを使うため、OS とユーザー設定によって通知の現れ方やふるまいは変わってきます。
77 notifications.create()
通知を生成、表示します。
78 omnibox API, Add-ons, Extensions, Reference, WebExtensions, omnibox
拡張機能に、ユーザーがアドレスバーに入力した時のカスタマイズされた振る舞いを有効にします。
79 pageAction API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, pageAction
ページアクション (en-US) は、ブラウザーのアドレスバーの中のクリックできるアイコンです。
80 pageAction.onClicked
ページアクションのアイコンがクリックされたときに発火します。ページアクションがポップアップを持っているならこのイベントは発火しません。
81 permissions API, Add-ons, Extensions, Permissions, Reference, WebExtensions
拡張機能は強力な WebExtension API の多くにアクセスするパーミッション(アクセス権)を必要とします。manifest.json の permissions に必要なパーミッション記述することで、インストール時にユーザーに対しパーミッションを要求できます。インストール時にパーミッションを要求する主なメリットは次の通りです:
82 pkcs11
pkcs11 API は拡張機能にセキュリティモジュール PKCS #11 の列挙を可能とし、キーの元と証明書としてブラウザーからアクセスできるようにします。
83 privacy API, Add-ons, Extensions, Privacy, Reference, WebExtensions
さまざまなプライバシー関連のブラウザー設定にアクセスや変更を行います。
84 proxy API, Add-ons, Proxy, WebExtensions
拡張された Proxy Auto-Configuration (PAC) file (これはウェブのリクエストをプロキシ化するポリシーを実装します) を実装するのにプロキシ API を使います。この実装は標準の PAC 設計といくつかそれていて、なぜなら PAC ファイルのデファクト仕様は 1995年頃の初期実装から変えられてないためです。仕様を維持している標準化団体はありません。
85 runtime API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, runtime
このモジュールは拡張機能と、それを実行する環境についての情報を提供します。
86 runtime.MessageSender API, Add-ons, Extensions, MessageSender, Non-standard, Reference, Type, WebExtensions, runtime
メッセージや接続要求の送信元に関する情報を持つオブジェクトです。このオブジェクトは、runtime.onMessage() リスナーに渡されます。
87 runtime.onMessage API, Add-ons, Event, Extensions, Non-standard, Reference, WebExtensions, onmessage, runtime
onMessage リスナーに受信させるメッセージを送るには、runtime.sendMessage()、または (コンテンツスクリプトにメッセージを送るときは) tabs.sendMessage() を使います。
88 runtime.openOptionsPage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, openOptionsPage, runtime
これは Promise を返す非同期関数です。
89 runtime.sendMessage() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, runtime, sendMessage
単一のメッセージを、自分や別の拡張機能が持つイベントリスナーに送信します。
90 sessions API, Add-ons, Extensions, Non-standard, Reference, WebExtensions, sessions
セッション API を使ってブラウザーが動作している間に閉じたタブやウィンドウを一覧、復帰します。
91 sidebarAction API, Extensions, Non-standard, Reference, Sidebar, WebExtensions, sidebarAction
拡張機能のサイドバーのプロパティを取得、設定します。
92 storage API, Add-ons, Extensions, Interface, Non-standard, Reference, Storage, WebExtensions
拡張機能にデータの保存、取得と、保存項目の変更をリッスンできるようにします。
93 storage.local
local ストレージ領域を指します。localストレージ内のアイテムはその拡張機能がインストールされたマシン内で利用できます。
94 storage.StorageArea
StorageArea はストレージ領域を表すオブジェクトです。
95 StorageArea.clear() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, remove
全てのアイテムをストレージ領域から削除します。
96 StorageArea.get() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, get
ストレージ領域から1つ以上のアイテムを取得します。
97 StorageArea.getBytesInUse() API, Add-ons, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, getBytesInUse
1つ以上のストレージ領域内に格納されたアイテムが占めるストレージ空間をバイト単位で取得します。
98 StorageArea.remove() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, remove
1つ以上のアイテムをストレージ領域から削除します。
99 StorageArea.set() API, Add-ons, Extensions, Method, Non-standard, Reference, Storage, StorageArea, WebExtensions, set
1つ以上のアイテムをストレージ領域に保存または上書きします。
100 storage.StorageChange API, Add-ons, Extensions, Non-standard, Reference, Storage, StorageChange, Type, WebExtensions
StorageChange オブジェクトは以下のプロパティを持ちます。
101 storage.sync API, Add-ons, Extensions, Non-standard, Property, Reference, Storage, Sync, WebExtensions
sync ストレージ領域を指します。 sync ストレージ内のアイテムはブラウザーによって同期され、ログイン(Firefox sync や Google アカウントなど)しているブラウザー・デバイスの全てのインスタンスで利用できます。
102 tabs API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, tabs, タブ
ブラウザーのタブシステムとやりとりします。
103 tabs.captureVisibleTab() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, captureVisibleTab, tabs
指定ウィンドウの選択タブの表示領域の画像をエンコードしたデータ URI を作成します。このメソッドを使うには <all_urls> パーミッション が必要です (Chrome の場合、activeTab パーミッション があり、ユーザーが許可の操作を行えば、このメソッドを使うことができます)。
104 tabs.create()
新しいタブを作ります。
105 tabs.duplicate()
ID で指定されたタブを複製します。
106 tabs.executeScript() API, Add-ons, Extensions, Method, Non-standard, Reference, WebExtensions, executeScript, tabs
JavaScript のコードをページに挿入します。
107 tabs.get()
タブのIDを指定し、tabs.Tabオブジェクトとしてタブの詳細を取得します。
108 tabs.MutedInfo
This object contains a boolean indicating whether the tab is muted, and the reason for the last state change.
109 tabs.MutedInfoReason
タブがミュート・アンミュートになった理由を指定します。
110 tabs.onCreated
タブが生成されたときに発火します。
111 tabs.query()
指定されたプロパティを持つ全てのタブを取得します。何も指定しない場合、全てのタブを取得します。
112 tabs.remove()
1つ以上のタブを閉じます。
113 tabs.Tab
tabs.Tab型はタブについての情報を含んでいます。これはタブの中のコンテンツについての情報へのアクセスを提供します。例えば、コンテンツはどれくらいの大きさか、どのような特別な状態もしくは制限が有効になっているか、など。
114 theme Extensions, Themes, WebExtensions, add-on
ブラウザー拡張機能がブラウザーのテーマを更新できるようにします。
115 topSites API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, topSites
topSites API を使うと、ユーザーがよく訪れるページをを含む配列を取得できます。
116 types API, Add-ons, Extensions, Reference, Types, WebExtensions
ブラウザー設定を表すのに使われる BrowserSetting 型を定義します。
117 webNavigation API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, webNavigation
ナビゲーションのいろいろな段階でイベントリスナーを追加します。ナビゲーションにはある URL から他に移動するブラウザーフレームにより成り立っていて、それは(いつもではなく)通常はリンクのクリックやロケーションバーへの URL 入力といったユーザー操作の応答として発生します。
118 webRequest API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, webRequest
websocket が ws:// and wss:// としてリクエストするものも含めた、HTTP リクエスト作成のいろいろなステージでイベントリスナーを追加します。イベントリスナーはリクエストの詳細情報を受け取ったり、リクエストを編集、修正したりします。
119 windows API, Add-ons, Extensions, Interface, Non-standard, Reference, WebExtensions, Windows
ブラウザーウィンドウと相互作用します。この API を使って開いているウィンドウの情報を取得したり、ウィンドウを開き、修正し、閉じることができます。ウィンドウのオープン、クローズ、アクティベートのイベントをリッスンすることもできます。
120 windows.WindowState
ブラウザウィンドウの状態。
121 windows.WindowType
これはブラウザウィンドウの種類です。
122 manifest.json のブラウザー互換性 Add-ons, WebExtensions, manifest.json
No summary!
123 JavaScript API 群のブラウザ実装状況 Reference, WebExtensions
No summary!
124 Chrome との非互換性 WebExtensions, 初心者向け
Webextension を用いた拡張機能は Chrome や Opera の拡張機能と互換性があるように設計されています。可能な限り、それぞれのブラウザー向けに書かれた拡張機能は最低限の変更で Firefox で実行できるように設計されています。
125 コンテンツスクリプト WebExtensions
コンテンツスクリプトは、特定のウェブページのコンテキストで実行される拡張機能の一部です(拡張機能の一部であるバックグラウンドスクリプトや、ウェブサイト自体の一部であるスクリプト、例えば script 要素みたいなものと対をなすような)。
126 Content Security Policy WebExtensions

WebExtension APIs で開発される拡張機能には、既定で適用される CSP(Content Security Policy の略) があります。これは <script><object> リソースから読み込まれるソースを制限し、危険な行動、例えば eval() の使用を非許可にします。

この記事では CSP とは何かと、デフォルトポリシーとは何で拡張機能にはどんな意味があるのかと、拡張機能が既定の CSP を変更する方法を簡単に説明します。

127 デバッグ (Firefox 50 より前)
この記事では、デフォルトでインストールされている Firefox 開発ツールを使って、WebExtension API で開発された拡張機能をどのようにデバッグするか説明します。Add-on SDK で開発したアドオンをデバッグする場合は、アドオンデバッガ の解説を参照してください。
128 ThunderbirdにおけるWebExtensionsによるアドイン開発
Thunderbirdのアドイン開発はFirefoxと同様の方法でコーディングすることが可能です。
テキストエディタや、あなたの選んだコーディングツールで。
129 拡張機能の例 Interface, WebExtensions
拡張機能の開発方法を分かりやすく説明するため、シンプルな拡張機能のサンプルを集めたリポジトリ https://github.com/mdn/webextensions-examples を公開しています。この記事では、そのリポジトリで使われている WebExtension API について説明します。
130 developer tools の拡張 Add-ons, DevTools, Needs Privileges, WebExtensions, ガイド, 拡張機能
WebExtensions API を使用して、ブラウザの組み込み開発者ツールを拡張できます。
131 設定ページを実装する WebExtensions
設定ページは、ユーザーに拡張機能の設定を確認して変える方法を与えます(「プリファレンス」や「オプション」とも呼ばれます)。
132 クリップボードとのやりとり WebExtensions
document.execCommand()を使用することで、WebExtension API で構築されたブラウザー拡張がシステムのクリップボードと連携できるようになります:
133 HTTP リクエストへの介入 Add-ons, Extensions, How-to, WebExtensions
HTTP リクエストへ介入するには webRequest API を用います。 この API を利用すると、HTTP リクエストの生成段階における様々なタイミングにリスナ関数を追加できます。追加したリスナの中では、以下の処理を行うことができます。
134 国際化 Article, Guide, Internationalization, Localization, WebExtensions, i18n, messages.json, placeholders, predefined messages
WebExtensions API には、拡張機能を国際化するとても簡単なモジュール — i18n があります。この記事ではその機能を見てみて、どのように動作するのかの実例を提供します。WebExtensions API を使った拡張機能用の i18n システムは、i18n.js のような、よくある i10n 用 JavaScript ライブラリーと同様です。
135 manifest.json Add-ons, Extensions, WebExtensions
manifest.json ファイルは、WebExtension API を使う拡張機能に必ず含めなければならない唯一のファイルです。
136 author Add-ons, Extensions, WebExtensions
拡張機能の作者で、ブラウザーの UI で表示されることを目的とするものです。developer キーが与えられてそこに "name" プロパティが含まれる場合、それは author キーを上書きします。複数の作者を指定する方法はありません。
137 background Add-ons, Extensions, Manifest, Reference, WebExtensions
background を使って拡張機能に 1 つ以上のバックグラウンドスクリプトや、オプションとしてバックグラウンドページを含めます。
138 browser_action Add-ons, Extensions, WebExtensions
browser actionはあなたのブラウザーのツールバーに拡張機能のボタンを追加します。ボタンはアイコンと、オプションでHTML、CSSとJavaScriptを使用した、ポップアップコンテンツを使用できます。
139 browser_specific_settings Add-ons, Extensions, WebExtensions, manifest.json
通常は不要です ( いつ Add-on ID が必要か?を参考に) 。Firefox 48 より前と Android版Firefox では必須です。
140 chrome_settings_overrides Add-ons, Extensions, WebExtensions, chrome_settings_overrides, manifest.json
chrome_settings_overrides キーを使ってブラウザー設定を上書きします。2つの設定が利用できます:
141 chrome_url_overrides Add-ons, Extensions, WebExtensions
chrome_url_overrides キーを使って、通常はブラウザー自身が行っているいろいろなページへの文書の置き換えをカスタムすることができます。
142 commands Add-ons, Extensions, WebExtensions
commands キーを使うと拡張機能用のキーボードショートカットを定義できます。
143 content_scripts Add-ons, Extensions, WebExtensions
タイプ
144 content_security_policy Add-ons, Extensions, WebExtensions
拡張機能はデフォルトでCSP(content security policy)が適用されています。デフォルトのポリシーの場合、ソースは <script> タグ及び <object> タグからのみロードできるように制限されており、 eval()のような潜在的に安全でない慣習(バッドプラクティス)は制限されます。この実装のより詳細は Default content security policyを見てください。
145 default_locale Add-ons, Extensions, WebExtensions
このキーは拡張機能が _locales ディレクトリを含んでいる場合は必要で、そうでない場合は不要です。これは _locales のサブディレクトリを識別し、このサブディレクトリは拡張機能の既定の文字列を探すために使用されます。
146 description Add-ons, Extensions, WebExtensions
ブラウザーのユーザーインターフェースに表示するための、拡張機能の簡単な説明です。
147 developer Add-ons, Extensions, WebExtensions
拡張機能の開発者の名前と、そのホームページ URL で、ブラウザーの UI に表示されるためのもの。
148 devtools_page
このキーを使って拡張機能にブラウザー組み込みの開発ツールを拡張することができます。
149 homepage_url Add-ons, Extensions, WebExtensions
拡張機能のホームページの URL です。
150 icons Add-ons, Extensions, WebExtensions
The icons key specifies icons for your extension. Those icons will be used to represent the extension in components such as the Add-ons Manager.
151 incognito Add-ons, WebExtensions, incognito, manifest.json
incognito キーを使ってプライベートブラウジングウィンドウで機能拡張が動作する方法を管理できます。
152 manifest_version Add-ons, Extensions, WebExtensions
このキーは、拡張機能で使用される manifest.json のバージョンを指定します。
153 name Add-ons, Extensions, WebExtensions
拡張機能の名前です。これはブラウザーのユーザーインターフェースや addons.mozilla.org のようなサイトで拡張機能を識別するために使用されます。
154 omnibox Add-ons, Extensions, WebExtensions
omnibox を使って拡張機能のための omnibox キーワードを定義します。
155 optional_permissions Add-ons, WebExtensions, manifest.json, optional_permissions
optional_permissions キーを使って、拡張機能がインストールされた後に、実行時に要求するパーミッションを一覧できます。
156 options_ui Add-ons, Extensions, WebExtensions
options_ui キーは、拡張機能のオプションページを定義するために使用します。
157 page_action Add-ons, Extensions, WebExtensions
ページアクションは拡張機能がブラウザーのURLバーの中に追加できるアイコンです。
158 permissions Add-ons, Extensions, WebExtensions
拡張機能が特別な権限を必要とする際には permission キーを使用します。このキーには文字列の配列を指定し、各文字列がパーミッションを要求します。
159 protocol_handlers Add-ons, Extensions, WebExtensions, manifest.json
このキーを使ってウェブベースのプロトコルハンドラーを登録します。
160 short_name Add-ons, Extensions, WebExtensions
拡張機能の短い名前。与えられた場合、これは name 項目が長過ぎるコンテキストで使われます。短い名前は 12 文字を超えないことが推奨されます。manifest.json に短い名前が入ってない場合、name が代わりに使われて切り捨てられることがあります。
161 sidebar_action WebExtensions
サイドバー (en-US)はブラウザーウィンドウの左側の、ウェブページの横に表示されるペインです。ブラウザーはユーザーに現在利用できるサイドバーを表示して表示するサイドバーを選ぶUIを提供します。
162 theme Add-ons, Themes
theme キーを使って Firefox に適用する静的なテーマを定義します。
163 version_name Add-ons, Extensions, WebExtensions
アップデート目的で使われる version 項目に加えて、version_name はバージョン説明の文字列をセットできて、存在する場合は表示目的に使われます。
164 version Add-ons, Extensions, WebExtensions
はい
165 web_accessible_resources Add-ons, Extensions, WebExtensions
いいえ
166 マッチパターン WebExtensions
マッチパターンは URL のグループを指定する方法です。マッチパターンはいくつかの URL にマッチします。マッチパターンは WebExtensions API を使う拡張機能向けに、いくつかの場所で使用されます。特にコンテンツスクリプトをロードする文書を指定するときや、webRequest リスナーを追加する URL を指定する時に使用します。
167 ウェブページを変更する WebExtensions
拡張機能の一般的な事例の1つはウェブページを変更することです。例えば、ページのスタイルを変更、特定の DOM ノードを隠す、別の DOM ノードをページに挿入する、といいでしょう。
168 ネイティブマニフェスト Extensions, WebExtensions
ネイティブマニフェストは特別な形式の JSON ファイルで、拡張機能のインストールプロセスの範囲外の方法でユーザーのコンピューターに配布されます。例えば、ネイティブマニフェストは端末の管理者やネイティブアプリケーションのインストーラーによって配布されます。
169 Native messaging WebExtensions
Native messaging はユーザーのコンピューターにインストールされたアプリケーションと拡張機能との間のメッセージ交換を可能にします。 Native messaging を利用すれば、ネイティブアプリケーションが Web を介してアクセスできなくても拡張機能にサービスを提供できます。典型的な利用例としてはパスワードマネージャーが挙げられます。ネイティブアプリケーションはパスワードの暗号化と保管を行い、拡張機能と通信して Web フォームに入力を行うといったことが可能です。さらに、Native messaging を用いることで、一部のハードウェア等の WebExtension API ではアクセスできないリソースに対してアドオンからアクセスできるようになります。
170 前提条件
WebExtension API を使って開発するには、いくつかの小さいセットアップが必要です。
171 Tips and Tricks
このページには開発者がWebExtensionsを開発するのに便利ないろいろなコツや技術が書かれています。
172 ユーザーインターフェイス Landing, User Interface, WebExtensions
WebExtension API を使った機能拡張にはいくつかのユーザーインターフェイスオプションが提供されていて、ユーザーがこれによって機能を利用できます。この節では、下記にこのオプションの要約と、各ユーザーインターフェイスオプションの詳細な導入とがあります。
173 ツールバーボタン WebExtension
よくブラウザーアクションとして参照され、 このユーザーインターフェイスオプションはブラウザーのツールバーに追加されるボタンです。 ユーザーはボタンをクリックして拡張機能とやりとりします。
174 コンテキストメニュー項目 WebExtensions
このユーザーインターフェイスオプションは、ブラウザーのコンテキストメニューに1つ以上の項目を追加します。これはユーザーがウェブページを右クリックした時に利用できるコンテキストメニューです。タブも browser.menus API を通じてコンテキストメニューを持つことができます。
175 開発ツールパネル Beginner, Guide, User Interface, WebExtensions
拡張機能が開発者に使われるツールを提供するとき、ブラウザーの開発ツールに、新しいパネルとしてUIを追加できます。
176 Extension pages Beginner, User Interface, WebExtensions
拡張機能にはフォームやヘルプなど拡張機能が必要とするコンテンツを提供するためのHTMLを含めることができます。
177 通知 WebExtensions
通知では、OS の通知サービスを使って、拡張機能やそのコンテンツについての情報を通信することができます:
178 オプションページ WebExtensions
オプションページでは、ユーザーから変更できるような拡張機能の設定画面を定義します。ユーザーはアドオンマネージャを通じて、アドオンのオプションページにアクセスできます。
179 アドレスバーボタン User Interface, WebExtensions
よくページアクションとして参照され、このユーザーインターフェイスオプションはブラウザーのアドレスバーに追加されるボタンです。ユーザーはボタンをクリックして拡張機能とやりとりします。
180 ポップアップ UI, User Interface, WebExtensions, popup
ポップアップはツールバーボタンアドレスバーボタンに関連したダイアログです。
181 サイドバー WebExtensions
サイドバーはブラウザーウィンドウの横側の、ウェブページの隣に表示されるペイン(枠)です。ブラウザーはユーザーに、 現在利用しているサイドバーを表示するUIと表示させるサイドバーを選ぶUIを提供します。例えば、Firefox には"表示 > サイドバー" メニューがあります。サイドバーは同時に一つだけ表示できて、すべてのタブとすべてのブラウザーウィンドウに表示されます。
182 拡張機能とは何か? Extensions, WebExtensions
拡張機能はウェブブラウザーに機能を追加します。標準化されている web 技術(JavaScript / HTML / CSS)に専用の JavaScript API をいくつか加えて書かれます。とりわけ、拡張機能はブラウザーに新しい機能を追加したり、特定のウェブサイトが持つ見た目やコンテンツを変更したりできます。
183 次にどうするのか? Beginner, Extensions, WebExtension
ブラウザー拡張機能のアイデアを実現化していく準備ができているでしょう。開発の旅に出る前に、いくつかの注意点を意識することはスムーズに旅をする上で価値があります。
184 Bookmarks API を使う Add-ons, Beginner, Bookmarks, Extensions, How-to, WebExtensions
ブックマークにより、ユーザーはウェブページのリストを集めたり編集したりできて、お気に入りに簡単に戻ることができます。Bookmarks API を使って、拡張機能はユーザーができるのとほぼ同じ方法でブックマークを操作できます。
185 ファイルの操作 Guide, WebExtensions
拡張機能にて完全な機能を提供するのにファイルを操作する必要があるかもしれません。この記事ではファイルを扱うための 5 つのメカニズムを見ていきます:
186 Tabs API を使う Add-ons, Beginner, Extensions, How-to, WebExtensions, tabs
タブを使うとユーザーはブラウザーウィンドウに複数のウェブページを開いてウェブページ間をスイッチできるようになります。Tabs API により、タブを操作して、新しい方法でタブを使ったり拡張機能の機能として配布できます。
187 初めての拡張機能 Guide, WebExtensions
この記事では、Firefox 用の拡張機能をどのように作ればよいのか、その初めから最後までを一通り説明します。この拡張機能は "mozilla.org" とそのサブドメインから読み込まれたページに赤い枠を付けるだけです。
188 2 つめの拡張機能 WebExtensions
この記事では、API の使い方をより詳しく説明するため、前回よりも少し複雑なアドオンを書いてみます。