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> Le `StatusBar` objet fournit quelques fonctions pour personnaliser les iOS et Android StatusBar.
 25
 26## Installation
 27
 28    cordova plugin add cordova-plugin-statusbar
 29    
 30
 31## Préférences
 32
 33#### config.xml
 34
 35*   **StatusBarOverlaysWebView** (boolean, la valeur par défaut true). Sur iOS 7, faire la superposition de statusbar ou pas superposition le WebView au démarrage.
 36    
 37        <preference name="StatusBarOverlaysWebView" value="true" />
 38        
 39
 40*   **StatusBarBackgroundColor** (chaîne hexadécimale de couleur, par défaut, #000000). Sur iOS 7, définir la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale (#RRGGBB) au démarrage.
 41    
 42        <preference name="StatusBarBackgroundColor" value="#000000" />
 43        
 44
 45*   **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.
 46    
 47        <preference name="StatusBarStyle" value="lightcontent" />
 48        
 49
 50## Cacher au démarrage
 51
 52Pendant 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.
 53
 54Ajouter/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 :
 55
 56    <key>UIStatusBarHidden</key>
 57    <true/>
 58    <key>UIViewControllerBasedStatusBarAppearance</key>
 59    <false/>
 60    
 61
 62## Méthodes
 63
 64Ce plugin définit objet `StatusBar` global.
 65
 66Bien que dans la portée globale, il n'est pas disponible jusqu'après la `deviceready` événement.
 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## Propriétés
 85
 86*   StatusBar.isVisible
 87
 88## Autorisations
 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
 99Sur iOS 7, faire la statusbar superposition ou pas superposer le WebView.
100
101    StatusBar.overlaysWebView(true);
102    
103
104## Description
105
106Sur 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.
107
108## Plates-formes supportées
109
110*   iOS
111
112## Exemple court
113
114    StatusBar.overlaysWebView(true);
115    StatusBar.overlaysWebView(false);
116    
117
118# StatusBar.styleDefault
119
120Utilisez la barre de statut par défaut (texte sombre, pour les arrière-plans lumineux).
121
122    StatusBar.styleDefault();
123    
124
125## Plates-formes prises en charge
126
127*   iOS
128*   Windows Phone 7
129*   Windows Phone 8
130*   Windows Phone 8.1
131
132# StatusBar.styleLightContent
133
134Utilisez la barre d'État lightContent (texte clair, des arrière-plans sombres).
135
136    StatusBar.styleLightContent();
137    
138
139## Plates-formes prises en charge
140
141*   iOS
142*   Windows Phone 7
143*   Windows Phone 8
144*   Windows Phone 8.1
145
146# StatusBar.styleBlackTranslucent
147
148Utilisez la barre d'État blackTranslucent (texte clair, des arrière-plans sombres).
149
150    StatusBar.styleBlackTranslucent();
151    
152
153## Plates-formes prises en charge
154
155*   iOS
156*   Windows Phone 7
157*   Windows Phone 8
158*   Windows Phone 8.1
159
160# StatusBar.styleBlackOpaque
161
162Utilisez la barre d'État blackOpaque (texte clair, des arrière-plans sombres).
163
164    StatusBar.styleBlackOpaque();
165    
166
167## Plates-formes prises en charge
168
169*   iOS
170*   Windows Phone 7
171*   Windows Phone 8
172*   Windows Phone 8.1
173
174# StatusBar.backgroundColorByName
175
176Sur 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.
177
178    StatusBar.backgroundColorByName("red");
179    
180
181Les noms de couleurs prises en charge sont :
182
183    black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
184    
185
186## Plates-formes prises en charge
187
188*   iOS
189*   Windows Phone 7
190*   Windows Phone 8
191*   Windows Phone 8.1
192
193# StatusBar.backgroundColorByHexString
194
195Définit la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale.
196
197    StatusBar.backgroundColorByHexString("#C0C0C0");
198    
199
200Propriétés de raccourci CSS sont également pris en charge.
201
202    StatusBar.backgroundColorByHexString("#333"); // => #333333
203    StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
204    
205
206Sur 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).
207
208Sur WP7 et WP8, vous pouvez également spécifier des valeurs comme #AARRGGBB, où AA représente une valeur alpha
209
210## Plates-formes prises en charge
211
212*   iOS
213*   Windows Phone 7
214*   Windows Phone 8
215*   Windows Phone 8.1
216
217# StatusBar.hide
218
219Masquer la barre d'État.
220
221    StatusBar.hide();
222    
223
224## Plates-formes prises en charge
225
226*   iOS
227*   Android
228*   Windows Phone 7
229*   Windows Phone 8
230*   Windows Phone 8.1
231
232# StatusBar.show
233
234Affiche la barre d'État.
235
236    StatusBar.show();
237    
238
239## Plates-formes prises en charge
240
241*   iOS
242*   Android
243*   Windows Phone 7
244*   Windows Phone 8
245*   Windows Phone 8.1
246
247# StatusBar.isVisible
248
249Lire cette propriété afin de voir si la barre d'État est visible ou non.
250
251    if (StatusBar.isVisible) {
252        // do something
253    }
254    
255
256## Plates-formes supportées
257
258*   iOS
259*   Android
260*   Windows Phone 7
261*   Windows Phone 8
262*   Windows Phone 8.1