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.

275 lines
7.2 KiB

8 years ago
  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. # cordova-plugin-statusbar
  20. [![Build Status](https://travis-ci.org/apache/cordova-plugin-statusbar.svg)](https://travis-ci.org/apache/cordova-plugin-statusbar)
  21. # StatusBar
  22. > El `StatusBar` objeto proporciona algunas funciones para personalizar el iOS y Android StatusBar.
  23. ## Instalación
  24. cordova plugin add cordova-plugin-statusbar
  25. ## Preferencias
  26. #### config.xml
  27. * **StatusBarOverlaysWebView** (boolean, true por defecto). En iOS 7, hacer la superposición statusbar o no superponer la WebView al inicio.
  28. <preference name="StatusBarOverlaysWebView" value="true" />
  29. * **StatusBarBackgroundColor** (color hex string por defecto #000000). IOS 7 y 5 Android, configurar el color de fondo de la barra de estado por una cadena hexadecimal (#RRGGBB) en el arranque.
  30. <preference name="StatusBarBackgroundColor" value="#000000" />
  31. * **StatusBarStyle** (status bar estilo por defecto lightcontent). En iOS 7, definir el estilo de barra de estado. Por defecto las opciones disponibles, lightcontent, blacktranslucent, blackopaque.
  32. <preference name="StatusBarStyle" value="lightcontent" />
  33. ### Rarezas Android
  34. Android 5 + pautas especifican utilizando un color diferente para la barra de estado que la aplicación principal de color (a diferencia del color de barra de estado uniforme de muchas apps de iOS 7 +), por lo que puede establecer el color de la barra de estado en tiempo de ejecución en su lugar a través de `StatusBar.backgroundColorByHexString` o `StatusBar.backgroundColorByName`. Una forma de hacerlo sería:
  35. ```js
  36. if (cordova.platformId == 'android') {
  37. StatusBar.backgroundColorByHexString("#333");
  38. }
  39. ```
  40. ## Escondido en el arranque
  41. Durante el tiempo de ejecución puede utilizar la función StatusBar.hide abajo, pero si quieres la barra de estado que está escondido en el inicio de la aplicación, se debe modificar el archivo Info.plist de su aplicación.
  42. Agregar/editar estos dos atributos si no está presente. Defina **"inicialmente se esconde la barra de estado"** a **"YES"** y **"Aparición de vista basado en controlador estatus bar"** a **"NO"**. Si se edita manualmente sin Xcode, las claves y valores son:
  43. <key>UIStatusBarHidden</key>
  44. <true/>
  45. <key>UIViewControllerBasedStatusBarAppearance</key>
  46. <false/>
  47. ## Métodos
  48. Este plugin define global `StatusBar` objeto.
  49. Aunque en el ámbito global, no estará disponible hasta después de la `deviceready` evento.
  50. document.addEventListener("deviceready", onDeviceReady, false);
  51. function onDeviceReady() {
  52. console.log(StatusBar);
  53. }
  54. * StatusBar.overlaysWebView
  55. * StatusBar.styleDefault
  56. * StatusBar.styleLightContent
  57. * StatusBar.styleBlackTranslucent
  58. * StatusBar.styleBlackOpaque
  59. * StatusBar.backgroundColorByName
  60. * StatusBar.backgroundColorByHexString
  61. * StatusBar.hide
  62. * StatusBar.show
  63. ## Propiedades
  64. * StatusBar.isVisible
  65. ## Permisos
  66. #### config.xml
  67. <feature name="StatusBar">
  68. <param name="ios-package" value="CDVStatusBar" onload="true" />
  69. </feature>
  70. # StatusBar.overlaysWebView
  71. En iOS 7, hacer la barra de estado superposición o no superponer la vista Web.
  72. StatusBar.overlaysWebView(true);
  73. ## Descripción
  74. En iOS 7, establecida en false para que la barra de estado aparezca como iOS 6. Establece el color de fondo y estilo para utilizar las otras funciones.
  75. ## Plataformas soportadas
  76. * iOS
  77. ## Ejemplo rápido
  78. StatusBar.overlaysWebView(true);
  79. StatusBar.overlaysWebView(false);
  80. # StatusBar.styleDefault
  81. Utilice la barra de estado por defecto (texto oscuro, para fondos de luz).
  82. StatusBar.styleDefault();
  83. ## Plataformas soportadas
  84. * iOS
  85. * Windows Phone 7
  86. * Windows Phone 8
  87. * Windows Phone 8.1
  88. # StatusBar.styleLightContent
  89. Utilice la barra de estado lightContent (texto ligero, para fondos oscuros).
  90. StatusBar.styleLightContent();
  91. ## Plataformas soportadas
  92. * iOS
  93. * Windows Phone 7
  94. * Windows Phone 8
  95. * Windows Phone 8.1
  96. # StatusBar.styleBlackTranslucent
  97. Utilice la barra de estado blackTranslucent (texto ligero, para fondos oscuros).
  98. StatusBar.styleBlackTranslucent();
  99. ## Plataformas soportadas
  100. * iOS
  101. * Windows Phone 7
  102. * Windows Phone 8
  103. * Windows Phone 8.1
  104. # StatusBar.styleBlackOpaque
  105. Utilice la barra de estado blackOpaque (texto ligero, para fondos oscuros).
  106. StatusBar.styleBlackOpaque();
  107. ## Plataformas soportadas
  108. * iOS
  109. * Windows Phone 7
  110. * Windows Phone 8
  111. * Windows Phone 8.1
  112. # StatusBar.backgroundColorByName
  113. En iOS 7, al establecer StatusBar.statusBarOverlaysWebView a false, se puede establecer el color de fondo de la barra de estado nombre del color.
  114. StatusBar.backgroundColorByName("red");
  115. Nombres de los colores admitidos son:
  116. black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
  117. ## Plataformas soportadas
  118. * iOS
  119. * Android 5+
  120. * Windows Phone 7
  121. * Windows Phone 8
  122. * Windows Phone 8.1
  123. # StatusBar.backgroundColorByHexString
  124. Establece el color de fondo de la barra de estado por una cadena hexadecimal.
  125. StatusBar.backgroundColorByHexString("#C0C0C0");
  126. Propiedades CSS abreviada también son compatibles.
  127. StatusBar.backgroundColorByHexString("#333"); // => #333333
  128. StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
  129. En iOS 7, cuando se establece StatusBar.statusBarOverlaysWebView en false, se puede establecer el color de fondo de la barra de estado una cadena hexadecimal (#RRGGBB).
  130. En WP7 y WP8 también puede especificar valores como #AARRGGBB, donde AA es un valor alfa
  131. ## Plataformas soportadas
  132. * iOS
  133. * Android 5+
  134. * Windows Phone 7
  135. * Windows Phone 8
  136. * Windows Phone 8.1
  137. # StatusBar.hide
  138. Ocultar la barra de estado.
  139. StatusBar.hide();
  140. ## Plataformas soportadas
  141. * iOS
  142. * Android
  143. * Windows Phone 7
  144. * Windows Phone 8
  145. * Windows Phone 8.1
  146. # StatusBar.show
  147. Muestra la barra de estado.
  148. StatusBar.show();
  149. ## Plataformas soportadas
  150. * iOS
  151. * Android
  152. * Windows Phone 7
  153. * Windows Phone 8
  154. * Windows Phone 8.1
  155. # StatusBar.isVisible
  156. Lea esta propiedad para ver si la barra de estado es visible o no.
  157. if (StatusBar.isVisible) {
  158. // do something
  159. }
  160. ## Plataformas soportadas
  161. * iOS
  162. * Android
  163. * Windows Phone 7
  164. * Windows Phone 8
  165. * Windows Phone 8.1