README.md 7.25 KB
Newer Older
李晓兵's avatar
李晓兵 committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
<!---
# license: Licensed to the Apache Software Foundation (ASF) under one
#         or more contributor license agreements.  See the NOTICE file
#         distributed with this work for additional information
#         regarding copyright ownership.  The ASF licenses this file
#         to you under the Apache License, Version 2.0 (the
#         "License"); you may not use this file except in compliance
#         with the License.  You may obtain a copy of the License at
#
#           http://www.apache.org/licenses/LICENSE-2.0
#
#         Unless required by applicable law or agreed to in writing,
#         software distributed under the License is distributed on an
#         "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#         KIND, either express or implied.  See the License for the
#         specific language governing permissions and limitations
#         under the License.
-->

# cordova-plugin-statusbar

[![Build Status](https://travis-ci.org/apache/cordova-plugin-statusbar.svg)](https://travis-ci.org/apache/cordova-plugin-statusbar)

# StatusBar

> Das `StatusBar` Objekt stellt einige Funktionen zum Anpassen des iOS und Android StatusBar.

## Installation

    cordova plugin add cordova-plugin-statusbar
    

## "Einstellungen"

#### "config.xml"

  * **StatusBarOverlaysWebView** (Boolean, der Standardwert ist True). Stellen Sie auf iOS 7 die Statusbar-Overlay oder keine Überlagerung der WebView beim Start.
    
        <preference name="StatusBarOverlaysWebView" value="true" />
        

  * **StatusBarBackgroundColor** (Farbe hex String, Standardwert ist #000000). Auf iOS legen 7 und Android 5, Sie die Hintergrundfarbe der Statusbar von eine hexadezimale Zeichenfolge (#RRGGBB) beim Start.
    
        <preference name="StatusBarBackgroundColor" value="#000000" />
        

  * **StatusBarStyle** (Status Bar-Stil, der Standardwert ist Lightcontent). Legen Sie auf iOS 7 den Status-Bar-Stil. Verfügbaren Optionen Standard, Lightcontent, Blacktranslucent, Blackopaque.
    
        <preference name="StatusBarStyle" value="lightcontent" />
        

### Android Eigenarten

Die Android 5 + Leitlinien angeben, verwenden eine andere Farbe für die Statusbar als Ihre Hauptanwendung Farbe (anders als die einheitliche Statusbar Farbe viele iOS 7 + apps), so Sie die Statusbar Farbe zur Laufzeit statt über `StatusBar.backgroundColorByHexString` oder `StatusBar.backgroundColorByName`festzulegen möchten vielleicht. Eine Möglichkeit dazu wäre:

```js
if (cordova.platformId == 'android') {
    StatusBar.backgroundColorByHexString("#333");
}
```

## Beim Start ausblenden

Während der Laufzeit können Sie die StatusBar.hide-Funktion unten, aber die StatusBar beim Start der app versteckt werden soll, müssen Sie Ihre app Info.plist Datei ändern.

Diese beiden Attribute hinzufügen/bearbeiten, wenn nicht vorhanden. Legen Sie **"Statusleiste ist anfangs ausgeblendet"** auf **"YES"** und **"View Controller-basierte Status Bar aussehen"** auf **"NO"**. Wenn Sie es manuell ohne Xcode bearbeiten, werden die Schlüssel und Werte:

    <key>UIStatusBarHidden</key>
    <true/>
    <key>UIViewControllerBasedStatusBarAppearance</key>
    <false/>
    

## Methoden

Dieses Plugin wird globales `StatusBar`-Objekt definiert.

Obwohl im globalen Gültigkeitsbereich, steht es nicht bis nach dem `deviceready`-Ereignis.

    document.addEventListener("deviceready", onDeviceReady, false);
    function onDeviceReady() {
        console.log(StatusBar);
    }
    

  * StatusBar.overlaysWebView
  * StatusBar.styleDefault
  * StatusBar.styleLightContent
  * StatusBar.styleBlackTranslucent
  * StatusBar.styleBlackOpaque
  * StatusBar.backgroundColorByName
  * StatusBar.backgroundColorByHexString
  * StatusBar.hide
  * StatusBar.show

## Eigenschaften

  * StatusBar.isVisible

## Berechtigungen

#### "config.xml"

            <feature name="StatusBar">
                <param name="ios-package" value="CDVStatusBar" onload="true" />
            </feature>
    

# StatusBar.overlaysWebView

Stellen Sie auf iOS 7 Statusbar überlagern oder nicht überlagert die WebView.

    StatusBar.overlaysWebView(true);
    

## Beschreibung

Auf iOS 7 zu der Statusbar wie iOS 6 erscheinen auf False festgelegt. Legen Sie die Stil und Hintergrund Farbe entsprechend mit den anderen Funktionen.

## Unterstützte Plattformen

  * iOS

## Kurzes Beispiel

    StatusBar.overlaysWebView(true);
    StatusBar.overlaysWebView(false);
    

# StatusBar.styleDefault

Verwenden Sie die Standard-Statusbar (dunkle Text, für helle Hintergründe).

    StatusBar.styleDefault();
    

## Unterstützte Plattformen

  * iOS
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.styleLightContent

Verwenden Sie die LightContent-Statusbar (heller Text, für dunkle Hintergründe).

    StatusBar.styleLightContent();
    

## Unterstützte Plattformen

  * iOS
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.styleBlackTranslucent

Verwenden Sie die BlackTranslucent-Statusbar (heller Text, für dunkle Hintergründe).

    StatusBar.styleBlackTranslucent();
    

## Unterstützte Plattformen

  * iOS
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.styleBlackOpaque

Verwenden Sie die BlackOpaque-Statusbar (heller Text, für dunkle Hintergründe).

    StatusBar.styleBlackOpaque();
    

## Unterstützte Plattformen

  * iOS
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.backgroundColorByName

Auf iOS 7 Wenn Sie StatusBar.statusBarOverlaysWebView auf False festlegen, können Sie die Hintergrundfarbe der Statusbar von Farbnamen festlegen.

    StatusBar.backgroundColorByName("red");
    

Unterstützte Farbnamen sind:

    black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown
    

## Unterstützte Plattformen

  * iOS
  * Android 5+
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.backgroundColorByHexString

Legt die Hintergrundfarbe der Statusbar von eine hexadezimale Zeichenfolge fest.

    StatusBar.backgroundColorByHexString("#C0C0C0");
    

CSS-Kurzschrift-Eigenschaften werden ebenfalls unterstützt.

    StatusBar.backgroundColorByHexString("#333"); // => #333333
    StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
    

Auf iOS 7 Wenn Sie StatusBar.statusBarOverlaysWebView auf False festlegen, können Sie die Hintergrundfarbe der Statusbar von eine hexadezimale Zeichenfolge (#RRGGBB) festlegen.

Auf WP7 und WP8 können Sie auch Werte wie #AARRGGBB, angeben wo AA einen alpha-Wert ist

## Unterstützte Plattformen

  * iOS
  * Android 5+
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.hide

Ausblenden der Statusleiste.

    StatusBar.hide();
    

## Unterstützte Plattformen

  * iOS
  * Android
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.show

Zeigt die Statusleiste.

    StatusBar.show();
    

## Unterstützte Plattformen

  * iOS
  * Android
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1

# StatusBar.isVisible

Lesen Sie diese Eigenschaft, um festzustellen, ob die Statusbar sichtbar oder nicht ist.

    if (StatusBar.isVisible) {
        // do something
    }
    

## Unterstützte Plattformen

  * iOS
  * Android
  * Windows Phone 7
  * Windows Phone 8
  * Windows Phone-8.1