You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

262 lines
6.7 KiB

8 years ago
  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. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing,
  11. software distributed under the License is distributed on an
  12. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  13. KIND, either express or implied. See the License for the
  14. specific language governing permissions and limitations
  15. under the License.
  16. -->
  17. # cordova-plugin-statusbar
  18. # StatusBar
  19. > Le `StatusBar` objet fournit quelques fonctions pour personnaliser les iOS et Android StatusBar.
  20. ## Installation
  21. cordova plugin add cordova-plugin-statusbar
  22. ## Préférences
  23. #### config.xml
  24. * **StatusBarOverlaysWebView** (boolean, la valeur par défaut true). Sur iOS 7, faire la superposition de statusbar ou pas superposition le WebView au démarrage.
  25. <preference name="StatusBarOverlaysWebView" value="true" />
  26. * **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.
  27. <preference name="StatusBarBackgroundColor" value="#000000" />
  28. * **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.
  29. <preference name="StatusBarStyle" value="lightcontent" />
  30. ## Cacher au démarrage
  31. Pendant 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.
  32. Ajouter/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 :
  33. <key>UIStatusBarHidden</key>
  34. <true/>
  35. <key>UIViewControllerBasedStatusBarAppearance</key>
  36. <false/>
  37. ## Méthodes
  38. Ce plugin définit objet `StatusBar` global.
  39. Bien que dans la portée globale, il n'est pas disponible jusqu'après la `deviceready` événement.
  40. document.addEventListener("deviceready", onDeviceReady, false);
  41. function onDeviceReady() {
  42. console.log(StatusBar);
  43. }
  44. * StatusBar.overlaysWebView
  45. * StatusBar.styleDefault
  46. * StatusBar.styleLightContent
  47. * StatusBar.styleBlackTranslucent
  48. * StatusBar.styleBlackOpaque
  49. * StatusBar.backgroundColorByName
  50. * StatusBar.backgroundColorByHexString
  51. * StatusBar.hide
  52. * StatusBar.show
  53. ## Propriétés
  54. * StatusBar.isVisible
  55. ## Autorisations
  56. #### config.xml
  57. <feature name="StatusBar">
  58. <param name="ios-package" value="CDVStatusBar" onload="true" />
  59. </feature>
  60. # StatusBar.overlaysWebView
  61. Sur iOS 7, faire la statusbar superposition ou pas superposer le WebView.
  62. StatusBar.overlaysWebView(true);
  63. ## Description
  64. Sur 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.
  65. ## Plates-formes supportées
  66. * iOS
  67. ## Exemple court
  68. StatusBar.overlaysWebView(true);
  69. StatusBar.overlaysWebView(false);
  70. # StatusBar.styleDefault
  71. Utilisez la barre de statut par défaut (texte sombre, pour les arrière-plans lumineux).
  72. StatusBar.styleDefault();
  73. ## Plates-formes prises en charge
  74. * iOS
  75. * Windows Phone 7
  76. * Windows Phone 8
  77. * Windows Phone 8.1
  78. # StatusBar.styleLightContent
  79. Utilisez la barre d'État lightContent (texte clair, des arrière-plans sombres).
  80. StatusBar.styleLightContent();
  81. ## Plates-formes prises en charge
  82. * iOS
  83. * Windows Phone 7
  84. * Windows Phone 8
  85. * Windows Phone 8.1
  86. # StatusBar.styleBlackTranslucent
  87. Utilisez la barre d'État blackTranslucent (texte clair, des arrière-plans sombres).
  88. StatusBar.styleBlackTranslucent();
  89. ## Plates-formes prises en charge
  90. * iOS
  91. * Windows Phone 7
  92. * Windows Phone 8
  93. * Windows Phone 8.1
  94. # StatusBar.styleBlackOpaque
  95. Utilisez la barre d'État blackOpaque (texte clair, des arrière-plans sombres).
  96. StatusBar.styleBlackOpaque();
  97. ## Plates-formes prises en charge
  98. * iOS
  99. * Windows Phone 7
  100. * Windows Phone 8
  101. * Windows Phone 8.1
  102. # StatusBar.backgroundColorByName
  103. Sur 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.
  104. StatusBar.backgroundColorByName("red");
  105. Les noms de couleurs prises en charge sont :
  106. black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
  107. ## Plates-formes prises en charge
  108. * iOS
  109. * Windows Phone 7
  110. * Windows Phone 8
  111. * Windows Phone 8.1
  112. # StatusBar.backgroundColorByHexString
  113. Définit la couleur d'arrière-plan de la barre d'État par une chaîne hexadécimale.
  114. StatusBar.backgroundColorByHexString("#C0C0C0");
  115. Propriétés de raccourci CSS sont également pris en charge.
  116. StatusBar.backgroundColorByHexString("#333"); // => #333333
  117. StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
  118. Sur 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).
  119. Sur WP7 et WP8, vous pouvez également spécifier des valeurs comme #AARRGGBB, où AA représente une valeur alpha
  120. ## Plates-formes prises en charge
  121. * iOS
  122. * Windows Phone 7
  123. * Windows Phone 8
  124. * Windows Phone 8.1
  125. # StatusBar.hide
  126. Masquer la barre d'État.
  127. StatusBar.hide();
  128. ## Plates-formes prises en charge
  129. * iOS
  130. * Android
  131. * Windows Phone 7
  132. * Windows Phone 8
  133. * Windows Phone 8.1
  134. # StatusBar.show
  135. Affiche la barre d'État.
  136. StatusBar.show();
  137. ## Plates-formes prises en charge
  138. * iOS
  139. * Android
  140. * Windows Phone 7
  141. * Windows Phone 8
  142. * Windows Phone 8.1
  143. # StatusBar.isVisible
  144. Lire cette propriété afin de voir si la barre d'État est visible ou non.
  145. if (StatusBar.isVisible) {
  146. // do something
  147. }
  148. ## Plates-formes supportées
  149. * iOS
  150. * Android
  151. * Windows Phone 7
  152. * Windows Phone 8
  153. * Windows Phone 8.1