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
7.2 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. cordova plugin add cordova-plugin-statusbar
  22. ## 基本設定
  23. #### config.xml
  24. * **StatusBarOverlaysWebView**(ブール値、デフォルトは true)。IOS 7、起動時にステータスバー オーバーレイまたはないオーバーレイ、WebView を作る。
  25. <preference name="StatusBarOverlaysWebView" value="true" />
  26. * **StatusBarBackgroundColor**(色 16 進文字列、デフォルトは # 000000)。Ios 7、起動時に 16 進文字列 (#RRGGBB) でステータス バーの背景色を設定します。
  27. <preference name="StatusBarBackgroundColor" value="#000000" />
  28. * **StatusBarStyle**(ステータス バーのスタイル、既定値は lightcontent)。Ios 7、ステータス バーのスタイルを設定します。使用可能なオプションのデフォルト、lightcontent、blacktranslucent、blackopaque。
  29. <preference name="StatusBarStyle" value="lightcontent" />
  30. ## 起動時に非表示
  31. 実行時に下に、StatusBar.hide 関数を使用できますが、StatusBar アプリ起動時に非表示にする場合は、アプリの Info.plist ファイルを変更する必要があります。
  32. これら 2 つの属性の追加/編集存在しない場合。 **「ステータス バーが非表示最初」** **"YES"**を設定し、 **「ビュー コント ローラー ベースのステータス バーの外観」** **"NO"**にします。 Xcode せず手動で編集する、キーと値は。
  33. <key>UIStatusBarHidden</key>
  34. <true/>
  35. <key>UIViewControllerBasedStatusBarAppearance</key>
  36. <false/>
  37. ## メソッド
  38. このプラグインでは、グローバル `StatusBar` オブジェクトを定義します。
  39. グローバル スコープではあるがそれがないまで `deviceready` イベントの後です。
  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. ## プロパティ
  54. * StatusBar.isVisible
  55. ## アクセス許可
  56. #### config.xml
  57. <feature name="StatusBar">
  58. <param name="ios-package" value="CDVStatusBar" onload="true" />
  59. </feature>
  60. # StatusBar.overlaysWebView
  61. IOS 7、statusbar オーバーレイまたはない WebView をオーバーレイします。
  62. StatusBar.overlaysWebView(true);
  63. ## 解説
  64. IOS 7、iOS の 6 のように表示されるステータスバーを false に設定します。他の関数の使用に合わせてスタイルや背景色を設定します。
  65. ## サポートされているプラットフォーム
  66. * iOS
  67. ## 簡単な例
  68. StatusBar.overlaysWebView(true);
  69. StatusBar.overlaysWebView(false);
  70. # StatusBar.styleDefault
  71. 既定ステータス バー (暗いテキスト、淡色の背景) を使用します。
  72. StatusBar.styleDefault();
  73. ## サポートされているプラットフォーム
  74. * iOS
  75. * Windows Phone 7
  76. * Windows Phone 8
  77. * Windows Phone 8.1
  78. # StatusBar.styleLightContent
  79. LightContent ステータスバー (暗い背景の明るいテキスト) を使用します。
  80. StatusBar.styleLightContent();
  81. ## サポートされているプラットフォーム
  82. * iOS
  83. * Windows Phone 7
  84. * Windows Phone 8
  85. * Windows Phone 8.1
  86. # StatusBar.styleBlackTranslucent
  87. BlackTranslucent ステータスバー (暗い背景の明るいテキスト) を使用します。
  88. StatusBar.styleBlackTranslucent();
  89. ## サポートされているプラットフォーム
  90. * iOS
  91. * Windows Phone 7
  92. * Windows Phone 8
  93. * Windows Phone 8.1
  94. # StatusBar.styleBlackOpaque
  95. BlackOpaque ステータスバー (暗い背景の明るいテキスト) を使用します。
  96. StatusBar.styleBlackOpaque();
  97. ## サポートされているプラットフォーム
  98. * iOS
  99. * Windows Phone 7
  100. * Windows Phone 8
  101. * Windows Phone 8.1
  102. # StatusBar.backgroundColorByName
  103. Ios 7、StatusBar.statusBarOverlaysWebView を false に設定する場合はステータスバーの背景色の色の名前によって設定できます。
  104. StatusBar.backgroundColorByName("red");
  105. サポートされている色の名前は次のとおりです。
  106. black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
  107. ## サポートされているプラットフォーム
  108. * iOS
  109. * Windows Phone 7
  110. * Windows Phone 8
  111. * Windows Phone 8.1
  112. # StatusBar.backgroundColorByHexString
  113. 16 進文字列をステータス バーの背景色を設定します。
  114. StatusBar.backgroundColorByHexString("#C0C0C0");
  115. 速記の CSS プロパティもサポートされています。
  116. StatusBar.backgroundColorByHexString("#333"); // => #333333
  117. StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
  118. Ios 7、StatusBar.statusBarOverlaysWebView を false に設定する場合はステータスバーの背景色を 16 進文字列 (#RRGGBB) で設定できます。
  119. WP7 と WP8 も指定できます値 #AARRGGBB, AA は、アルファ値として
  120. ## サポートされているプラットフォーム
  121. * iOS
  122. * Windows Phone 7
  123. * Windows Phone 8
  124. * Windows Phone 8.1
  125. # StatusBar.hide
  126. ステータスバーを隠します。
  127. StatusBar.hide();
  128. ## サポートされているプラットフォーム
  129. * iOS
  130. * アンドロイド
  131. * Windows Phone 7
  132. * Windows Phone 8
  133. * Windows Phone 8.1
  134. # StatusBar.show
  135. ステータス バーが表示されます。
  136. StatusBar.show();
  137. ## サポートされているプラットフォーム
  138. * iOS
  139. * アンドロイド
  140. * Windows Phone 7
  141. * Windows Phone 8
  142. * Windows Phone 8.1
  143. # StatusBar.isVisible
  144. このプロパティ、ステータスバーが表示されるかどうかをお読みください。
  145. if (StatusBar.isVisible) {
  146. // do something
  147. }
  148. ## サポートされているプラットフォーム
  149. * iOS
  150. * アンドロイド
  151. * Windows Phone 7
  152. * Windows Phone 8
  153. * Windows Phone 8.1