1<!---
  2# license: 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[![Build Status](https://travis-ci.org/apache/cordova-plugin-statusbar.svg)](https://travis-ci.org/apache/cordova-plugin-statusbar)
 23
 24# StatusBar
 25
 26> Le `StatusBar` objet fournit quelques fonctions pour personnaliser les iOS et Android StatusBar.
 27
 28## Installation
 29
 30    cordova plugin add cordova-plugin-statusbar
 31    
 32
 33## Préférences
 34
 35#### config.Xml
 36
 37  * **StatusBarOverlaysWebView** (boolean, la valeur par défaut true). Sur iOS 7, faire la superposition de statusbar ou pas superposition le WebView au démarrage.
 38    
 39        <preference name="StatusBarOverlaysWebView" value="true" />
 40        
 41
 42  * **StatusBarBackgroundColor** (chaîne hexadécimale de couleur, par défaut, #000000). Sur iOS 7 et 5 Android, définir la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale (#RRGGBB) au démarrage.
 43    
 44        <preference name="StatusBarBackgroundColor" value="#000000" />
 45        
 46
 47  * **StatusBarStyle** (style de barre de statut, par défaut, lightcontent). Sur iOS 7, définir le style de barre de statut. Par défaut les options disponibles, lightcontent, blacktranslucent, blackopaque.
 48    
 49        <preference name="StatusBarStyle" value="lightcontent" />
 50        
 51
 52### Quirks Android
 53
 54Les lignes directrices 5 + Android spécifient à l'aide d'une couleur différente pour la barre d'État à votre application principale couleur (contrairement à la couleur uniforme statusbar de nombreuses applications iOS 7 +), donc vous pouvez définir la couleur de la barre d'état lors de l'exécution au lieu de cela via `StatusBar.backgroundColorByHexString` ou `StatusBar.backgroundColorByName`. Une façon de le faire serait :
 55
 56```js
 57if (cordova.platformId == 'android') {
 58    StatusBar.backgroundColorByHexString("#333");
 59}
 60```
 61
 62## Cacher au démarrage
 63
 64Pendant l'exécution, vous pouvez utiliser la fonction StatusBar.hide en bas, mais si vous souhaitez que la barre d'État pour être caché au démarrage de l'application, vous devez modifier le fichier Info.plist de votre application.
 65
 66Ajouter/modifier ces deux attributs si n'est pas présent. **"Barre d'État est initialement masqué"** la valeur **"** Yes" et **"À l'apparence vue sur contrôleur statut bar"** la valeur **"Non"**. Si vous modifiez manuellement sans Xcode, les clés et les valeurs sont :
 67
 68    <key>UIStatusBarHidden</key>
 69    <true/>
 70    <key>UIViewControllerBasedStatusBarAppearance</key>
 71    <false/>
 72    
 73
 74## Méthodes
 75
 76Ce plugin définit objet `StatusBar` global.
 77
 78Bien que dans la portée globale, il n'est pas disponible jusqu'après la `deviceready` événement.
 79
 80    document.addEventListener("deviceready", onDeviceReady, false);
 81    function onDeviceReady() {
 82        console.log(StatusBar);
 83    }
 84    
 85
 86  * StatusBar.overlaysWebView
 87  * StatusBar.styleDefault
 88  * StatusBar.styleLightContent
 89  * StatusBar.styleBlackTranslucent
 90  * StatusBar.styleBlackOpaque
 91  * StatusBar.backgroundColorByName
 92  * StatusBar.backgroundColorByHexString
 93  * StatusBar.hide
 94  * StatusBar.show
 95
 96## Propriétés
 97
 98  * StatusBar.isVisible
 99
100## Autorisations
101
102#### config.Xml
103
104            <feature name="StatusBar">
105                <param name="ios-package" value="CDVStatusBar" onload="true" />
106            </feature>
107    
108
109# StatusBar.overlaysWebView
110
111Sur iOS 7, faire la statusbar superposition ou pas superposer le WebView.
112
113    StatusBar.overlaysWebView(true);
114    
115
116## Description
117
118Sur iOS 7, la valeur false pour afficher la barre d'État comme iOS 6. Définissez la couleur de style et d'arrière-plan en fonction de l'utilisation des autres fonctions.
119
120## Plates-formes supportées
121
122  * iOS
123
124## Exemple court
125
126    StatusBar.overlaysWebView(true);
127    StatusBar.overlaysWebView(false);
128    
129
130# StatusBar.styleDefault
131
132Utilisez la barre de statut par défaut (texte sombre, pour les arrière-plans lumineux).
133
134    StatusBar.styleDefault();
135    
136
137## Plates-formes supportées
138
139  * iOS
140  * Windows Phone 7
141  * Windows Phone 8
142  * Windows Phone 8.1
143
144# StatusBar.styleLightContent
145
146Utilisez la barre d'État lightContent (texte clair, des arrière-plans sombres).
147
148    StatusBar.styleLightContent();
149    
150
151## Plates-formes supportées
152
153  * iOS
154  * Windows Phone 7
155  * Windows Phone 8
156  * Windows Phone 8.1
157
158# StatusBar.styleBlackTranslucent
159
160Utilisez la barre d'État blackTranslucent (texte clair, des arrière-plans sombres).
161
162    StatusBar.styleBlackTranslucent();
163    
164
165## Plates-formes supportées
166
167  * iOS
168  * Windows Phone 7
169  * Windows Phone 8
170  * Windows Phone 8.1
171
172# StatusBar.styleBlackOpaque
173
174Utilisez la barre d'État blackOpaque (texte clair, des arrière-plans sombres).
175
176    StatusBar.styleBlackOpaque();
177    
178
179## Plates-formes supportées
180
181  * iOS
182  * Windows Phone 7
183  * Windows Phone 8
184  * Windows Phone 8.1
185
186# StatusBar.backgroundColorByName
187
188Sur iOS 7, lorsque vous définissez StatusBar.statusBarOverlaysWebView sur false, vous pouvez définir la couleur d'arrière-plan de la barre d'État par nom de couleur.
189
190    StatusBar.backgroundColorByName("red");
191    
192
193Les noms de couleurs prises en charge sont :
194
195    black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
196    
197
198## Plates-formes supportées
199
200  * iOS
201  * Android 5+
202  * Windows Phone 7
203  * Windows Phone 8
204  * Windows Phone 8.1
205
206# StatusBar.backgroundColorByHexString
207
208Définit la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale.
209
210    StatusBar.backgroundColorByHexString("#C0C0C0");
211    
212
213Propriétés de raccourci CSS sont également pris en charge.
214
215    StatusBar.backgroundColorByHexString("#333"); // => #333333
216    StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
217    
218
219Sur iOS 7, lorsque vous définissez StatusBar.statusBarOverlaysWebView sur false, vous pouvez définir la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale (#RRGGBB).
220
221Sur WP7 et WP8, vous pouvez également spécifier des valeurs comme #AARRGGBB, où AA représente une valeur alpha
222
223## Plates-formes supportées
224
225  * iOS
226  * Android 5+
227  * Windows Phone 7
228  * Windows Phone 8
229  * Windows Phone 8.1
230
231# StatusBar.hide
232
233Masquer la barre d'État.
234
235    StatusBar.hide();
236    
237
238## Plates-formes supportées
239
240  * iOS
241  * Android
242  * Windows Phone 7
243  * Windows Phone 8
244  * Windows Phone 8.1
245
246# StatusBar.show
247
248Affiche la barre d'État.
249
250    StatusBar.show();
251    
252
253## Plates-formes supportées
254
255  * iOS
256  * Android
257  * Windows Phone 7
258  * Windows Phone 8
259  * Windows Phone 8.1
260
261# StatusBar.isVisible
262
263Lire cette propriété afin de voir si la barre d'État est visible ou non.
264
265    if (StatusBar.isVisible) {
266        // do something
267    }
268    
269
270## Plates-formes supportées
271
272  * iOS
273  * Android
274  * Windows Phone 7
275  * Windows Phone 8
276  * Windows Phone 8.1