aboutsummaryrefslogtreecommitdiff
path: root/files/ja/mozilla/add-ons/webextensions/manifest.json/sidebar_action/index.html
blob: 7fe517832cbd116c5a1841d6d03ac8565a914a8c (plain)
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
---
title: sidebar_action
slug: Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action
tags:
  - WebExtensions
translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action
---
<div>{{AddonSidebar}}</div>

<table class="fullwidth-table standard-table">
 <tbody>
  <tr>
   <th scope="row" style="width: 30%;"></th>
   <td><code>Object</code></td>
  </tr>
  <tr>
   <th scope="row">必須</th>
   <td>いいえ</td>
  </tr>
  <tr>
   <th scope="row"></th>
   <td>
    <pre class="brush: json no-line-numbers">
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "default_panel": "sidebar/sidebar.html"
}</pre>
   </td>
  </tr>
 </tbody>
</table>

<p><a href="/ja/docs/Mozilla/Add-ons/WebExtensions/Sidebars">サイドバー</a>はブラウザーウィンドウの左側の、ウェブページの横に表示されるペインです。ブラウザーはユーザーに現在利用できるサイドバーを表示して表示するサイドバーを選ぶUIを提供します。</p>

<p>sidebar_action キーによりサイドバーの既定のプロパティを定義できます。このプロパティは {{WebExtAPIRef("sidebarAction")}} API.を使って変更できます。</p>

<h2 id="Syntax" name="Syntax">構文</h2>

<p><code>sidebar_action</code> キーは下記に載っているプロパティを持つことのあるオブジェクトです。唯一の必須プロパティは <code>default_panel</code> です。</p>

<table class="fullwidth-table standard-table">
 <thead>
  <tr>
   <th scope="col">名前</th>
   <th scope="col"></th>
   <th scope="col">説明</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>browser_style</code></td>
   <td><code>Boolean</code></td>
   <td>
    <p>オプション、デフォルトでは <code>true</code></p>

    <p>Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other extensions that use the <code>browser_style</code> property.</p>
   </td>
  </tr>
  <tr>
   <td><code>default_icon</code></td>
   <td><code>Object</code> or <code>String</code></td>
   <td>
    <p>これはサイドバーのアイコンを指定するのに使います。このアイコンはブラウザーのUI内でサイドバーを開いたり閉じたりするのに表示されます。</p>

    <p>Icons are specified as URLs relative to the manifest.json file itself.</p>

    <p>You can specify a single icon file by supplying a string here:</p>

    <pre class="brush: json no-line-numbers">
"default_icon": "path/to/geo.svg"</pre>

    <p>To specify multiple icons in different sizes, specify an object here. The name of each property is the icon's height in pixels, and must be convertible to an integer. The value is the URL. For example:</p>

    <pre class="brush: json no-line-numbers">
    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }</pre>

    <p>See <a href="/ja/Add-ons/WebExtensions/manifest.json/browser_action#Choosing_icon_sizes">Choosing icon sizes</a> for more guidance on this.</p>

    <p>This property is optional: if it is omitted, the sidebar doesn't get an icon.</p>
   </td>
  </tr>
  <tr>
   <td><code>default_panel</code></td>
   <td><code>String</code></td>
   <td>
    <p>サイドバーのコンテンツを指定する HTML ファイルのパス。</p>

    <p>HTML ファイルには、普通のウェブページと同様に CSS と JavaScript ファイルを <code><a href="/ja/docs/Web/HTML/Element/link">&lt;link&gt;</a></code><code><a href="/ja/docs/Web/HTML/Element/script">&lt;script&gt;</a></code> 要素を使って入れることができます。</p>

    <p>普通のウェブページと異なり、パネル内で実行される JavaScript はすべての <a href="/ja/Add-ons/WebExtensions/API">WebExtension APIs</a> にアクセスできます(もちろん、拡張機能が持っている<a href="/ja/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions">権限</a>に従います)。</p>

    <p>このプロパティは必須です。</p>

    <p>これは<a href="https://developer.mozilla.org/ja/Add-ons/WebExtensions/Internationalization#Internationalizing_manifest.json">ローカライズ可能なプロパティです。</a></p>
   </td>
  </tr>
  <tr>
   <td><code>default_title</code></td>
   <td><code>String</code></td>
   <td>
    <p>サイドバーのタイトル。これはブラウザーのUIの中でサイドバーを一覧したり開くのに使われ、サイドバーが開いた時には上に表示されます。</p>

    <p>This property is optional: if it is omitted, the sidebar's title is the extension's <code><a href="https://developer.mozilla.org/ja/docs/Mozilla/Add-ons/WebExtensions/manifest.json/name">name</a></code>.</p>

    <p>This is a <a href="https://developer.mozilla.org/ja/Add-ons/WebExtensions/Internationalization#Internationalizing_manifest.json">localizable property</a>.</p>
   </td>
  </tr>
 </tbody>
</table>

<h2 id="Example" name="Example"></h2>

<pre class="brush: json no-line-numbers">"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "My sidebar!",
  "default_panel": "sidebar.html",
  "browser_style": true
}</pre>

<p>For a simple example of an extension that uses a sidebar, see <a href="https://github.com/mdn/webextensions-examples/tree/master/annotate-page">annotate-page</a>.</p>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザ実装状況</h2>

<p>{{Compat("webextensions.manifest.sidebar_action")}}</p>