Die Datei config.xml

Zahlreiche Aspekte der Verhaltensweisen einer App können über die globale Konfigurationsdatei config.xml gesteuert werden. Diese plattformunabhängig XML-Datei ist auf der W3C Gepackte Webanwendungen (Widgets) Spezifikation. Außerdem können hierüber erweiterte Kern-Cordova-API-Funktionen, Plugins und Plattform spezifische Einstellungen angeben werden.

Für Projekte, die mit der Cordova-CLI (beschrieben in The Command-Line Interface) erstellt werden, kann diese Datei im obersten Verzeichnis gefunden werden:

    app/config.xml

Beachten Sie, die Datei bei den Versionen 3.3.1-0.2.0 im Ordner app/www/config.xml zu finden ist, und das dies nach wie vor unterstützt wird.

Wenn die CLI ein Projekt erstellen, werden in verschiedenen Versionen dieser Datei passiv kopiert platforms/ Unterverzeichnisse, zum Beispiel:

    app/platforms/ios/AppName/config.xml
    app/platforms/blackberry10/www/config.xml
    app/platforms/android/res/xml/config.xml

Dieser Abschnitt beschreibt globale und Cross-Plattform-Konfigurationsoptionen. Finden Sie in den folgenden Abschnitten für Plattform-spezifische Optionen:

Neben der verschiedenen Konfigurationsoptionen unten können Sie auch eine Anwendung Kernsatz von Bildern für jede Zielplattform konfigurieren. Weitere Informationen finden Sie unter Symbole und Splash-Screens.

Kern-Konfigurationselemente

In diesem Beispiel wird den Standardwert config.xml erzeugt durch der CLI create Befehl, beschrieben in der Command-Line Interface:

    <widget id="com.example.hello" version="0.0.1">
        <name>HelloWorld</name>
        <description>
            A sample Apache Cordova application that responds to the deviceready event.
        </description>
        <author email="dev@callback.apache.org" href="http://cordova.io">
            Apache Cordova Team
        </author>
        <content src="index.html" />
        <access origin="*" />
    </widget>

Die folgenden Konfigurationselemente in der obersten Ebene angezeigt config.xml Datei und werden auf allen unterstützten Cordova-Plattformen unterstützt:

  • Die <widget> des Elements id Attribut bietet die app-Reverse-Domänen-ID, und der version seine vollständige Versionsnummer in Major/Minor/Patch-Notation ausgedrückt.

    Das Widget-Tag kann auch Attribute verfügen, die alternative Versionen, nämlich VersionCode für Android und CFBundleVersion für iOS angeben. Finden Sie im Abschnitt zusätzliche Versionsverwaltung unten für Details.

  • Die <name> Element gibt die app formalen Namen, wie er auf home-Bildschirm des Geräts und im app-Store-Schnittstellen erscheint.

  • Die <description> und <author> Elemente geben, Metadaten und Kontaktinformationen, die im app-Shop-Angebote angezeigt werden kann.

  • Der optionale <content> -Element definiert die app Startseite in der obersten Ebene Webverzeichnis Vermögenswerte. Der Standardwert ist index.html , die üblicherweise in einem Projekt angezeigt wird, ist der obersten Ebene www Verzeichnis.

  • <access>Elemente definieren den Satz der externen Domänen, die, denen die app erlaubt ist, zu kommunizieren. Der Standardwert, der oben gezeigten ermöglicht es, jeden beliebigen Server zugreifen. Finden Sie im Domain-Whitelist-Guide für Details.

  • Die <preference> Tag stellt verschiedene Optionen als Paare von name / value Attribute. Jede Vorliebe name ist case-insensitive. Viele Einstellungen sind nur für bestimmte Plattformen, wie oben auf dieser Seite aufgeführt. In den folgenden Abschnitten beschreiben die Einstellungen, die für mehrere Plattformen gelten.

Zusätzliche Versionsverwaltung

Sowohl Android als auch iOS Unterstützung eine zweite Versionszeichenfolge (oder Anzahl) zusätzlich zu dem oben sichtbar im app-Speicher, VersionCode für Android und CFBundleVersion für iOS. Unten ist ein Beispiel, das VersionCode und CFBundleVersion explizit festlegt

    <widget id="io.cordova.hellocordova"
      version="0.0.1"
      android-versionCode="7"
      ios-CFBundleVersion="3.3.3">

Wenn alternativversion nicht angegeben ist, werden die folgenden Standardwerte verwendet:

    // assuming version = MAJOR.MINOR.PATCH-whatever
    versionCode = PATCH + MINOR * 100 + MAJOR * 10000
    CFBundleVersion = "MAJOR.MINOR.PATCH"

Globale Voreinstellungen

Die folgenden globalen Einstellungen gelten für alle Plattformen:

  • Fullscreenkönnen Sie die Statusleiste am oberen Bildschirmrand ausblenden. Der Standardwert ist false . Beispiel:

    <preference name="Fullscreen" value="true" />

Multi-Plattform-Einstellungen

Die folgenden Einstellungen gelten für mehrere Plattformen, jedoch nicht auf alle von ihnen:

  • DisallowOverscroll(Boolean, wird standardmäßig auf false ): Legen Sie auf true Wenn Sie nicht möchten, dass die Schnittstelle jedes Feedback anzeigen, wenn Benutzer die Anfang oder Ende des Inhalts einen Bildlauf durchführen.

    <preference name="DisallowOverscroll" value="true"/>

    Gilt für Android und iOS. Auf iOS, Overscroll Gesten Ursache Inhalt zurück an seine ursprüngliche Position gut zu machen. Auf Android produzieren sie ein subtiler Glüheffekt am oberen oder unteren Rand des Inhalts.

  • BackgroundColor: Die app-Hintergrundfarbe festgelegt. Unterstützt eine 4-Byte hex-Wert, mit dem ersten Byte, die den Alphakanal und standard-RGB-Werte für die folgenden drei Bytes. In diesem Beispiel gibt blau:

    <preference name="BackgroundColor" value="0xff0000ff"/>

    Gilt für Android und BlackBerry. Überschreibt CSS anderweitig verfügbar auf allen Plattformen, zum Beispiel:body{background-color:blue}.

  • HideKeyboardFormAccessoryBar(Boolean, wird standardmäßig auf false ): Legen Sie auf true die zusätzliche Symbolleiste ausblenden, die oberhalb der Tastatur, wodurch angezeigt wird Benutzer aus einem Formulareingabe zum anderen navigieren.

    <preference name="HideKeyboardFormAccessoryBar" value="true"/>

    Gilt für BlackBerry.

  • Orientation (string, der Standardwert ist default): erlaubt Ihnen lock Orientierung und verhindern, dass die Schnittstelle rotierend in Reaktion auf Änderungen in der Ausrichtung. Mögliche Werte sind defaul, landscape oder portrait. Beispiel:

    <preference name="Orientation" value="landscape" />

    Darüber hinaus können Sie Plattform-spezifischen Ausrichtung Wert angeben, wenn Sie das <preference> Element innerhalb eines <plattform> Elements platzieren:

    <platform name="android">
    <preference name="Orientation" value="sensorLandscape" />
</platform>

    Gilt für Android, iOS, WP8, Amazon Fire OS und Firefox-OS.

    Hinweis: der default bedeutet Cordova entfernt den Orientierung-Präferenz-Eintrag aus der Plattform Manifest/Konfigurationsdatei ermöglicht die Plattform zum Ausweichen auf sein normales Verhalten.

    Für iOS um geben beide Porträt & Landschaft Modus verwenden der Plattform bestimmten Wert allSie:

    <platform name="ios">
    <preference name="Orientation" value="all" />
</platform>

Das Feature Element

Wenn Sie die CLI verwenden, um Anwendungen zu erstellen, verwenden Sie den plugin -Befehl Gerät APIs zu aktivieren. Dies ändert nicht die Datei auf oberster Ebene "config.xml" , also das <feature> nicht für Ihren Workflow gilt. Wenn Sie direkt in ein SDK und mit der plattformspezifischen config.xml -Datei als Quelle arbeiten, verwenden Sie das Tag <feature> Geräteebene APIs und externe Plugins aktivieren. Sie erscheinen oft mit benutzerdefinierten Werte in plattformspezifischen "config.xml" -Dateien. Hier ist beispielsweise die Device-API für Android Projekte angeben:

    <feature name="Device">
        <param name="android-package" value="org.apache.cordova.device.Device" />
    </feature>

Hier ist, wie das Element für iOS-Projekte wird angezeigt:

    <feature name="Device">
        <param name="ios-package" value="CDVDevice" />
    </feature>

Finden Sie die API-Referenz für Details jedes Feature angeben. Sehen Sie auf Plugins im Plugin-Entwicklerhandbuch für weitere Informationen.

Die Plattform Element

Wenn die CLI verwenden, um Anwendungen zu erstellen, ist es manchmal notwendig, Einstellungen oder anderen Elementen, die auf eine spezifische Plattform anzugeben. Verwenden Sie das Element <paltform> Konfiguration angeben, die nur in einer einzigen Plattform-spezifischen Datei config.xml -Datei angezeigt werden soll. Hier ist beispielsweise angeben, dass nur Android verwenden sollten, die Voreinstellung "Fullscreen":

    <platform name="android">
        <preference name="Fullscreen" value="true" />
    </platform>

Die hook Element

Stellt Ihr benutzerdefinierte Skript, das von Cordova aufgerufen wird, wenn bestimmte Aktion ausgeführt wird (z. B. nach Plugin hinzugefügt wird oder Plattform vorbereiten Logik wird aufgerufen). Dies ist nützlich, wenn Sie Cordova Standardfunktionalität verlängern müssen. Weitere Informationen finden Sie unter Haken Guide.

<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />