1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
---
title: sidebarAction
slug: Mozilla/Add-ons/WebExtensions/API/sidebarAction
tags:
- API
- Extensions
- Non-standard
- Reference
- Sidebar
- WebExtensions
- sidebarAction
translation_of: Mozilla/Add-ons/WebExtensions/API/sidebarAction
---
<div>{{AddonSidebar}}</div>
<p>拡張機能のサイドバーのプロパティを取得、設定します。</p>
<p><a href="/ja/docs/Mozilla/Add-ons/WebExtensions/Sidebars">サイドバー</a> はブラウザーウィンドウのウェブページの隣の、右側か左側にあるペインです。ブラウザーはユーザーが利用できるサイドバーを見て、表示するサイドバーを選択できる UI を提供します。manifest.json の <code><a href="/ja/Add-ons/WebExtensions/manifest.json/sidebar_action">sidebar_action</a></code> キーを使って、拡張機能は自身のサイドバーを定義できます。ここで述べる <code>sidebarAction</code> API を使って、拡張機能はサイドバーのプロパティを設定、取得できます。</p>
<p><code>sidebarAction</code> API は {{WebExtAPIRef("browserAction")}} API と緊密にモデリングされています。</p>
<p>sidebarAction API は Opera の <a href="https://dev.opera.com/extensions/sidebar-action-api/">sidebarAction API</a> を元にしていますが、次のものはサポートされていません: <code>setBadgeText()</code>, <code>getBadgeText()</code>, <code>setBadgeBackgroundColor()</code>, <code>getBadgeBackgroundColor()</code>, <code>onFocus</code>, <code>onBlur</code>.</p>
<h2 id="Types" name="Types">型</h2>
<dl>
<dt>{{WebExtAPIRef("sidebarAction.ImageDataType")}}</dt>
<dd>画像のピクセルデータ。<code><a href="/ja/docs/Web/API/ImageData">ImageData</a></code> オブジェクト (例えば、{{htmlelement("canvas")}} 要素からのもの)でなければならない。</dd>
</dl>
<h2 id="Functions" name="Functions">関数</h2>
<dl>
<dt>{{WebExtAPIRef("sidebarAction.setPanel()")}}</dt>
<dd>サイドバーのバネルを設定します。</dd>
<dt>{{WebExtAPIRef("sidebarAction.getPanel()")}}</dt>
<dd>サイドバーのバネルを取得します。</dd>
<dt>{{WebExtAPIRef("sidebarAction.setTitle()")}}</dt>
<dd>サイドバーのタイトルを設定します。これはブラウザーがサイドバーを一覧するあらゆる UI、例えばメニューに表示されます。</dd>
<dt>{{WebExtAPIRef("sidebarAction.getTitle()")}}</dt>
<dd>サイドバーのタイトルを取得します。</dd>
<dt>{{WebExtAPIRef("sidebarAction.setIcon()")}}</dt>
<dd>サイドバーのアイコンを設定します。</dd>
<dt>{{WebExtAPIRef("sidebarAction.open()")}}</dt>
<dd>サイドバーを開きます。</dd>
<dt>{{WebExtAPIRef("sidebarAction.close()")}}</dt>
<dd>サイドバーを閉じます。</dd>
<dt>{{WebExtAPIRef("sidebarAction.isOpen()")}}</dt>
<dd>サイドバーが開いているか否かをチェックします。</dd>
</dl>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザー実装状況</h2>
<p>{{Compat("webextensions.api.sidebarAction")}}</p>
<h2 id="Example_add-ons" name="Example_add-ons">add-ons の例</h2>
<ul>
<li><a class="external external-icon" href="https://github.com/mdn/webextensions-examples/tree/master/annotate-page">annotate-page</a></li>
</ul>
<div class="note"><strong>Acknowledgements</strong>
<p>This API is based on Opera's <a href="https://dev.opera.com/extensions/sidebar-action-api/"><code>chrome.sidebarAction</code></a> API.</p>
<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>
<div class="hidden">
<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>
|
