openEventsPlatformApp/plugins/cordova-plugin-statusbar/doc/ja/index.md
plugins/cordova-plugin-statusbar/doc/ja/index.mdRaw
1<!---
2 Licensed to the Apache Software Foundation (ASF) under one
3 or more contributor license agreements. See the NOTICE file
4 distributed with this work for additional information
5 regarding copyright ownership. The ASF licenses this file
6 to you under the Apache License, Version 2.0 (the
7 "License"); you may not use this file except in compliance
8 with the License. You may obtain a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing,
13 software distributed under the License is distributed on an
14 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 KIND, either express or implied. See the License for the
16 specific language governing permissions and limitations
17 under the License.
18-->
19
20# cordova-plugin-statusbar
21
22# StatusBar
23
24> `StatusBar`オブジェクトは、iOS と Android ステータス バーをカスタマイズするいくつかの機能を提供します。
25
26## インストール
27
28 cordova plugin add cordova-plugin-statusbar
29
30
31## 基本設定
32
33#### config.xml
34
35* **StatusBarOverlaysWebView**(ブール値、デフォルトは true)。IOS 7、起動時にステータスバー オーバーレイまたはないオーバーレイ、WebView を作る。
36
37 <preference name="StatusBarOverlaysWebView" value="true" />
38
39
40* **StatusBarBackgroundColor**(色 16 進文字列、デフォルトは # 000000)。Ios 7、起動時に 16 進文字列 (#RRGGBB) でステータス バーの背景色を設定します。
41
42 <preference name="StatusBarBackgroundColor" value="#000000" />
43
44
45* **StatusBarStyle**(ステータス バーのスタイル、既定値は lightcontent)。Ios 7、ステータス バーのスタイルを設定します。使用可能なオプションのデフォルト、lightcontent、blacktranslucent、blackopaque。
46
47 <preference name="StatusBarStyle" value="lightcontent" />
48
49
50## 起動時に非表示
51
52実行時に下に、StatusBar.hide 関数を使用できますが、StatusBar アプリ起動時に非表示にする場合は、アプリの Info.plist ファイルを変更する必要があります。
53
54これら 2 つの属性の追加/編集存在しない場合。 **「ステータス バーが非表示最初」** **"YES"**を設定し、 **「ビュー コント ローラー ベースのステータス バーの外観」** **"NO"**にします。 Xcode せず手動で編集する、キーと値は。
55
56 <key>UIStatusBarHidden</key>
57 <true/>
58 <key>UIViewControllerBasedStatusBarAppearance</key>
59 <false/>
60
61
62## メソッド
63
64このプラグインでは、グローバル `StatusBar` オブジェクトを定義します。
65
66グローバル スコープではあるがそれがないまで `deviceready` イベントの後です。
67
68 document.addEventListener("deviceready", onDeviceReady, false);
69 function onDeviceReady() {
70 console.log(StatusBar);
71 }
72
73
74* StatusBar.overlaysWebView
75* StatusBar.styleDefault
76* StatusBar.styleLightContent
77* StatusBar.styleBlackTranslucent
78* StatusBar.styleBlackOpaque
79* StatusBar.backgroundColorByName
80* StatusBar.backgroundColorByHexString
81* StatusBar.hide
82* StatusBar.show
83
84## プロパティ
85
86* StatusBar.isVisible
87
88## アクセス許可
89
90#### config.xml
91
92 <feature name="StatusBar">
93 <param name="ios-package" value="CDVStatusBar" onload="true" />
94 </feature>
95
96
97# StatusBar.overlaysWebView
98
99IOS 7、statusbar オーバーレイまたはない WebView をオーバーレイします。
100
101 StatusBar.overlaysWebView(true);
102
103
104## 解説
105
106IOS 7、iOS の 6 のように表示されるステータスバーを false に設定します。他の関数の使用に合わせてスタイルや背景色を設定します。
107
108## サポートされているプラットフォーム
109
110* iOS
111
112## 簡単な例
113
114 StatusBar.overlaysWebView(true);
115 StatusBar.overlaysWebView(false);
116
117
118# StatusBar.styleDefault
119
120既定ステータス バー (暗いテキスト、淡色の背景) を使用します。
121
122 StatusBar.styleDefault();
123
124
125## サポートされているプラットフォーム
126
127* iOS
128* Windows Phone 7
129* Windows Phone 8
130* Windows Phone 8.1
131
132# StatusBar.styleLightContent
133
134LightContent ステータスバー (暗い背景の明るいテキスト) を使用します。
135
136 StatusBar.styleLightContent();
137
138
139## サポートされているプラットフォーム
140
141* iOS
142* Windows Phone 7
143* Windows Phone 8
144* Windows Phone 8.1
145
146# StatusBar.styleBlackTranslucent
147
148BlackTranslucent ステータスバー (暗い背景の明るいテキスト) を使用します。
149
150 StatusBar.styleBlackTranslucent();
151
152
153## サポートされているプラットフォーム
154
155* iOS
156* Windows Phone 7
157* Windows Phone 8
158* Windows Phone 8.1
159
160# StatusBar.styleBlackOpaque
161
162BlackOpaque ステータスバー (暗い背景の明るいテキスト) を使用します。
163
164 StatusBar.styleBlackOpaque();
165
166
167## サポートされているプラットフォーム
168
169* iOS
170* Windows Phone 7
171* Windows Phone 8
172* Windows Phone 8.1
173
174# StatusBar.backgroundColorByName
175
176Ios 7、StatusBar.statusBarOverlaysWebView を false に設定する場合はステータスバーの背景色の色の名前によって設定できます。
177
178 StatusBar.backgroundColorByName("red");
179
180
181サポートされている色の名前は次のとおりです。
182
183 black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
184
185
186## サポートされているプラットフォーム
187
188* iOS
189* Windows Phone 7
190* Windows Phone 8
191* Windows Phone 8.1
192
193# StatusBar.backgroundColorByHexString
194
19516 進文字列をステータス バーの背景色を設定します。
196
197 StatusBar.backgroundColorByHexString("#C0C0C0");
198
199
200速記の CSS プロパティもサポートされています。
201
202 StatusBar.backgroundColorByHexString("#333"); // => #333333
203 StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
204
205
206Ios 7、StatusBar.statusBarOverlaysWebView を false に設定する場合はステータスバーの背景色を 16 進文字列 (#RRGGBB) で設定できます。
207
208WP7 と WP8 も指定できます値 #AARRGGBB, AA は、アルファ値として
209
210## サポートされているプラットフォーム
211
212* iOS
213* Windows Phone 7
214* Windows Phone 8
215* Windows Phone 8.1
216
217# StatusBar.hide
218
219ステータスバーを隠します。
220
221 StatusBar.hide();
222
223
224## サポートされているプラットフォーム
225
226* iOS
227* アンドロイド
228* Windows Phone 7
229* Windows Phone 8
230* Windows Phone 8.1
231
232# StatusBar.show
233
234ステータス バーが表示されます。
235
236 StatusBar.show();
237
238
239## サポートされているプラットフォーム
240
241* iOS
242* アンドロイド
243* Windows Phone 7
244* Windows Phone 8
245* Windows Phone 8.1
246
247# StatusBar.isVisible
248
249このプロパティ、ステータスバーが表示されるかどうかをお読みください。
250
251 if (StatusBar.isVisible) {
252 // do something
253 }
254
255
256## サポートされているプラットフォーム
257
258* iOS
259* アンドロイド
260* Windows Phone 7
261* Windows Phone 8
262* Windows Phone 8.1