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.

238 lines
7.6 KiB

7 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. > Объект `StatusBar` предоставляет некоторые функции для настройки статусной панели на iOS и Android.
  20. ## Настройки
  21. #### config.xml
  22. * **StatusBarOverlaysWebView** (логическое значение, по умолчанию true). В iOS 7 определяет необходимо ли сделать наложение статусной панели на WebView при запуске или нет.
  23. <preference name="StatusBarOverlaysWebView" value="true" />
  24. * **StatusBarBackgroundColor** (шестнадцатеричная строка цвета, значения по умолчанию #000000). На iOS 7 установит цвет фона статусной панели при запуске, на основании шестнадцатеричной строки цвета (#RRGGBB).
  25. <preference name="StatusBarBackgroundColor" value="#000000" />
  26. * **StatusBarStyle** (статус бар стиль, по умолчанию lightcontent). На iOS 7 установите стиль строки состояния. Доступные параметры по умолчанию, lightcontent, blacktranslucent, blackopaque.
  27. <preference name="StatusBarStyle" value="lightcontent" />
  28. ## Скрытие при запуске
  29. Во время выполнения можно использовать функцию StatusBar.hide ниже, но если вы хотите StatusBar быть скрыты при запуске приложения, необходимо изменить файл Info.plist вашего приложения.
  30. Добавьте/измените эти два атрибута, если они не присутствуют или отличаются от нижеуказанных значений. Установите значение **«Status bar is initially hidden»** равное **«YES»** и установите значение **«View controller-based status bar appearance»** на **«NO»**. Если вы измените его вручную без Xcode, ключи и значения являются следующими:
  31. <key>UIStatusBarHidden</key>
  32. <true/>
  33. <key>UIViewControllerBasedStatusBarAppearance</key>
  34. <false/>
  35. ## Методы
  36. * StatusBar.overlaysWebView
  37. * StatusBar.styleDefault
  38. * StatusBar.styleLightContent
  39. * StatusBar.styleBlackTranslucent
  40. * StatusBar.styleBlackOpaque
  41. * StatusBar.backgroundColorByName
  42. * StatusBar.backgroundColorByHexString
  43. * StatusBar.hide
  44. * StatusBar.show
  45. ## Параметры
  46. * StatusBar.isVisible
  47. ## Разрешения
  48. #### config.xml
  49. <feature name="StatusBar">
  50. <param name="ios-package" value="CDVStatusBar" onload="true" />
  51. </feature>
  52. # StatusBar.overlaysWebView
  53. На iOS 7 Сделайте statusbar overlay или не поверх WebView.
  54. StatusBar.overlaysWebView(true);
  55. ## Описание
  56. На iOS 7 Установите значение false чтобы сделать statusbar появляются как iOS 6. Задайте стиль и цвет фона в соответствии с использованием других функций.
  57. ## Поддерживаемые платформы
  58. * iOS
  59. ## Краткий пример
  60. StatusBar.overlaysWebView(true);
  61. StatusBar.overlaysWebView(false);
  62. # StatusBar.styleDefault
  63. Используйте по умолчанию statusbar (темный текст, для легких стола).
  64. StatusBar.styleDefault();
  65. ## Поддерживаемые платформы
  66. * iOS
  67. * Windows Phone 7
  68. * Windows Phone 8
  69. # StatusBar.styleLightContent
  70. Используйте lightContent statusbar (светлый текст, на темном фоне).
  71. StatusBar.styleLightContent();
  72. ## Поддерживаемые платформы
  73. * iOS
  74. * Windows Phone 7
  75. * Windows Phone 8
  76. # StatusBar.styleBlackTranslucent
  77. Используйте blackTranslucent statusbar (светлый текст, на темном фоне).
  78. StatusBar.styleBlackTranslucent();
  79. ## Поддерживаемые платформы
  80. * iOS
  81. * Windows Phone 7
  82. * Windows Phone 8
  83. # StatusBar.styleBlackOpaque
  84. Используйте blackOpaque statusbar (светлый текст, на темном фоне).
  85. StatusBar.styleBlackOpaque();
  86. ## Поддерживаемые платформы
  87. * iOS
  88. * Windows Phone 7
  89. * Windows Phone 8
  90. # StatusBar.backgroundColorByName
  91. На iOS 7 когда StatusBar.statusBarOverlaysWebView присвоено значение false, можно задать цвет фона для объекта statusbar по имени цвета.
  92. StatusBar.backgroundColorByName("red");
  93. Имена поддерживаемых цветов являются:
  94. black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
  95. ## Поддерживаемые платформы
  96. * iOS
  97. * Windows Phone 7
  98. * Windows Phone 8
  99. # StatusBar.backgroundColorByHexString
  100. Задает цвет фона для объекта statusbar, шестнадцатеричная строка.
  101. StatusBar.backgroundColorByHexString("#C0C0C0");
  102. Также поддерживаются свойства CSS стенографию.
  103. StatusBar.backgroundColorByHexString("#333"); // => #333333
  104. StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
  105. На iOS 7 когда StatusBar.statusBarOverlaysWebView присвоено значение false, можно задать цвет фона для объекта statusbar, шестнадцатеричная строка (#RRGGBB).
  106. На WP7 и WP8 также можно указать значения как #AARRGGBB, где AA — это альфа-значение
  107. ## Поддерживаемые платформы
  108. * iOS
  109. * Windows Phone 7
  110. * Windows Phone 8
  111. # StatusBar.hide
  112. Скройте строку состояния statusbar.
  113. StatusBar.hide();
  114. ## Поддерживаемые платформы
  115. * iOS
  116. * Android
  117. * Windows Phone 7
  118. * Windows Phone 8
  119. # StatusBar.show
  120. Показывает строку состояния statusbar.
  121. StatusBar.show();
  122. ## Поддерживаемые платформы
  123. * iOS
  124. * Android
  125. * Windows Phone 7
  126. * Windows Phone 8
  127. # StatusBar.isVisible
  128. Чтение это свойство, чтобы увидеть, если statusbar является видимым или нет.
  129. if (StatusBar.isVisible) {
  130. // do something
  131. }
  132. ## Поддерживаемые платформы
  133. * iOS
  134. * Android
  135. * Windows Phone 7
  136. * Windows Phone 8