Config.xml

Config.xml — это глобальный конфигурационный файл, который управляет многими аспектами поведения приложения cordova. Этот платформенно-независимый XML-файл организован в соответствии со спецификацией W3C Packaged Web Apps (Widgets) и расширен для указания основных функций Cordova API, плагинов и платформ-специфичных настроек.

Для проектов, созданных с помощью Cordova CLI (описанного в Руководстве по интерфейсу командной строки), этот файл можно найти в корневом каталоге:

app/config.xml

Обратите внимание, что до версии 3.3.1-0.2.0 файл находился по адресу app/www/config.xml, и его расположение здесь по-прежнему поддерживается.

При использовании CLI для сборки проекта версии этого файла пассивно копируются в различные platforms/ подкаталоги. Например:

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

В дополнение к различным параметрам конфигурации, описанным ниже, вы также можете настроить набор основных изображений приложения для каждой целевой платформы. Подробнее см. раздел по настройке значков.

widget

Корневой элемент документа config.xml.

Примеры:

<!-- Android -->
<widget id="io.cordova.hellocordova" version="0.0.1" android-versionCode="13" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- iOS -->
<widget id="io.cordova.hellocordova" version="0.0.1" ios-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- Windows -->
<widget id="io.cordova.hellocordova" version="0.0.1" windows-packageVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

<!-- OS X -->
<widget id="io.cordova.hellocordova" version="0.0.1" osx-CFBundleVersion="0.1.3" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
</widget>

name

Указывает официальное имя приложения, которое отображается на главном экране устройства и в интерфейсах магазинов приложений.

Примеры:

<widget ...>
   <name>HelloCordova</name>
</widget>

краткое имя

Указывает необязательное имя для отображения приложения. Иногда имя приложения должно отображаться на главном экране устройства по-другому, чем в информационных и магазинах приложений из-за ограниченного места.

Примеры:

<widget ...>
   <name short="HiCdv">HelloCordova</name>
</widget>

описание

Указывает метаданные, которые могут отображаться в списках приложений в магазинах.

Примеры:

<widget ...>
   <description>A sample Apache Cordova application</description>
</widget>

автор

Указывает контактную информацию, которая может отображаться в списках приложений в магазинах.

Примеры:

<widget ...>
   <author email="dev@cordova.apache.org" href="http://cordova.io"></author>
</widget>

контент

Определяет начальную страницу приложения в каталоге веб-активов верхнего уровня. Значение по умолчанию — index.html, который обычно находится в корневом www каталоге проекта.

находится в корневом www каталоге проекта.

Примеры:

<widget ...>
   <content src="startPage.html"></content>
</widget>

доступ

Определяет набор внешних доменов, с которыми приложение разрешено взаимодействовать. Значение по умолчанию, показанное выше, позволяет ему получать доступ к любому серверу. Подробнее см. в Руководстве по списку разрешенных доменов.

Значение по умолчанию, показанное выше, позволяет ему получать доступ к любому серверу. Подробнее см. в Руководстве по списку разрешенных доменов.

Примеры:

<widget ...>
   <access origin="*"></access>
</widget>

<widget ...>
   <access origin="http://google.com"></access>
</widget>

разрешить навигацию

Управляет URL-адресами, к которым WebView может переходить. Применяется только к переходам верхнего уровня.

Подробнее см. cordova-plugin-whitelist.

Примеры:

<!-- Allow links to example.com -->
<allow-navigation href="http://example.com/*" />

<!-- Wildcards are allowed for the protocol, as a prefix to the host, or as a suffix to the path -->
<allow-navigation href="*://*.example.com/*" />

разрешить намерение

Управляет URL-адресами, для открытия которых приложение может запросить систему. По умолчанию внешние URL-адреса запрещены.

Подробнее см. cordova-plugin-whitelist.

Примеры:

<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
<allow-intent href="tel:*" />
<allow-intent href="sms:*" />

edit-config

См. документацию по plugin.xml.

config-file

См. документацию по plugin.xml.

engine

Указывает подробности о платформе, которая должна быть восстановлена во время подготовки.

Примеры:

<engine name="android" spec="https://github.com/apache/cordova-android.git#5.1.1" />
<engine name="ios" spec="^4.0.0" />

plugin

Указывает подробности о плагине, который должен быть восстановлен во время подготовки. Этот элемент автоматически добавляется в проект config.xml при добавлении плагина с помощью флага --save. Подробнее см. справочную информацию по CLI по добавлению плагинов.

Примеры:

<plugin name="cordova-plugin-device" spec="^1.1.0" />
<plugin name="cordova-plugin-device" spec="https://github.com/apache/cordova-plugin-device.git#1.0.0" />

переменная

Сохраняет значение переменной CLI, которая будет использоваться при восстановлении плагина во время подготовки. Этот элемент добавляется в config.xml при добавлении плагина, использующего переменные CLI, с флагом --save. Подробнее см. справочную информацию по CLI по добавлению плагинов.

Обратите внимание, что это значение используется только при восстановлении плагина в проект во время подготовки. Изменение его не изменит значение, используемое плагином в текущем проекте. Для того чтобы изменения в этом значении вступили в силу, удалите плагин из проекта и восстановите его, выполнив cordova prepare. Подробнее см. элемент preference в plugin.xml.

Примеры:

<plugin name="cordova-plugin-device" spec="^1.1.0">
    <variable name="MY_VARIABLE" value="my_variable_value" />
</plugin>

настройка

Устанавливает различные параметры в виде пар имя/значение. Имя каждой настройки нечувствительно к регистру. Многие настройки уникальны для определенных платформ, что будет указано.

Примеры:

<preference name="DisallowOverscroll" value="true"/>
<preference name="Fullscreen" value="true" />
<preference name="BackgroundColor" value="0xff0000ff"/>
<preference name="HideKeyboardFormAccessoryBar" value="true"/>
<preference name="Orientation" value="landscape" />

<!-- iOS only preferences -->
<preference name="EnableViewportScale" value="true"/>
<preference name="MediaPlaybackAllowsAirPlay" value="false"/>
<preference name="MediaPlaybackRequiresUserAction" value="true"/>
<preference name="AllowInlineMediaPlayback" value="true"/>
<preference name="BackupWebStorage" value="local"/>
<preference name="TopActivityIndicator" value="white"/>
<preference name="SuppressesIncrementalRendering" value="true"/>
<preference name="GapBetweenPages" value="0"/>
<preference name="PageLength" value="0"/>
<preference name="PaginationBreakingMode" value="page"/>
<preference name="PaginationMode" value="unpaginated"/>
<preference name="UIWebViewDecelerationSpeed" value="fast" />
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />
<preference name="target-device" value="universal" />
<preference name="deployment-target" value="7.0" />
<preference name="CordovaWebViewEngine" value="CDVUIWebViewEngine" />
<preference name="CordovaDefaultWebViewEngine" value="CDVUIWebViewEngine" />
<preference name="SuppressesLongPressGesture" value="true" />
<preference name="Suppresses3DTouchGesture" value="true" />

<!-- Android only preferences -->
<preference name="KeepRunning" value="false"/>
<preference name="LoadUrlTimeoutValue" value="10000"/>
<preference name="InAppBrowserStorageEnabled" value="true"/>
<preference name="LoadingDialog" value="My Title,My Message"/>
<preference name="ErrorUrl" value="myErrorPage.html"/>
<preference name="ShowTitle" value="true"/>
<preference name="LogLevel" value="VERBOSE"/>
<preference name="AndroidLaunchMode" value="singleTop"/>
<preference name="DefaultVolumeStream" value="call" />
<preference name="OverrideUserAgent" value="Mozilla/5.0 My Browser" />
<preference name="AppendUserAgent" value="My Browser" />

<!-- Windows only preferences -->
<preference name="windows-phone-target-version" value="8.1" />
<preference name="windows-target-version" value="8.1" />
<preference name="Windows.Universal" value="10.0.10240.0" />
<preference name="WindowsDefaultUriPrefix" value="ms-appx://" />
<preference name="Windows.Mobile-MaxVersionTested" value="10.0.10031.0" />
<preference name="Windows.Universal-MinVersion" value="10.0.0.0" />
<preference name="WindowsStoreIdentityName" value="Cordova.Example.ApplicationDataSample" />
<preference name="WindowsStorePublisherName" value="CN=Contoso Corp, O=Contoso Corp, L=Redmond, S=Washington, C=US" />
<preference name="WindowsToastCapable" value="true" />
<preference name="uap-target-min-version" value="10.0.10586.0" />

<!-- BlackBerry only preferences -->
<preference name="ChildBrowser" value="disable"/>
<preference name="PopupBlocker" value="enable"/>
<preference name="WebSecurity" value="disable"/>

<!-- OS X only preferences -->
<preference name="HideMousePointer" value="5"/>
<preference name="OSXLocalStoragePath" value="~/.myapp/database"/>
<preference name="WindowSize" value="800x400"/>
<preference name="EnableWebGL" value="true"/>

Функция

Если вы используете командную строку для сборки приложений, вы используете команду плагина для включения API устройств. Это не изменяет файл конфигурации верхнего уровня config.xml, поэтому элемент не применяется к вашему рабочему процессу. Если вы работаете непосредственно в SDK и используете файл конфигурации платформы config.xml в качестве источника, вы используете тег для включения API уровня устройств и внешних плагинов. Они часто появляются со специфичными для платформы значениями в файлах config.xml. См. Справочник по API для получения подробной информации о том, как указать каждую функцию. См. Руководство по разработке плагинов для получения дополнительной информации о плагинах. ПРИМЕЧАНИЕ: В большинстве случаев вам НУЖНО этого не делать.

Параметр

Используется для указания определённых параметров плагина, таких как: какой пакет для извлечения кода плагина и следует ли инициализировать код плагина во время инициализации Webview.

Примеры:

<!-- Here is how to specify the Device API for Android projects -->
<feature name="Device">
   <param name="android-package" value="org.apache.cordova.device.Device" />
</feature>

<!-- Here's how the element appears for iOS projects -->
<feature name="Device">
   <param name="ios-package" value="CDVDevice" />
   <param name="onload" value="true" />
</feature>

<!-- Here's how the element appears for OS X projects -->
<feature name="Device">
   <param name="osx-package" value="CDVDevice" />
   <param name="onload" value="true" />
</feature>

платформа

При использовании CLI для сборки приложений иногда необходимо указать предпочтения или другие элементы, специфичные для определенной платформы. Используйте элемент , чтобы указать конфигурацию, которая должна отображаться только в файле конфигурации config.xml, специфичном для определенной платформы.

Примеры:

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

хук

Представляет ваш пользовательский скрипт, который вызывается Cordova, когда происходит определенное действие (например, после добавления плагина или выполнения логики подготовки платформы). Это полезно, когда необходимо расширить стандартную функциональность Cordova. См. Руководство по хукам для получения дополнительной информации.

Примеры:

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

файл-ресурс

Этот тег устанавливает файлы ресурсов на вашей платформе и аналогичен тому же тегу в файле plugin.xml. Этот тег в настоящее время поддерживается только на cordova-ios@4.4.0 или более поздних версиях и cordova-android@6.2.1 или более поздних версиях.

Примеры:

Для Android:

<resource-file src="FooPluginStrings.xml" target="res/values/FooPluginStrings.xml" />

Пример config.xml

Ниже приведен пример файла config.xml:

<?xml version='1.0' encoding='utf-8'?>
<widget id="io.cordova.hellocordova" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">
  <name>HelloCordova</name>
  <description>
      A sample Apache Cordova application that responds to the deviceready event.
  </description>
  <author email="dev@cordova.apache.org" href="http://cordova.io">
      Apache Cordova Team
  </author>
  <content src="index.html" />
  <plugin name="cordova-plugin-whitelist" spec="1" />
  <access origin="*" />
  <allow-intent href="http://*/*" />
  <allow-intent href="https://*/*" />
  <allow-intent href="tel:*" />
  <allow-intent href="sms:*" />
  <allow-intent href="mailto:*" />
  <allow-intent href="geo:*" />
  <platform name="android">
      <allow-intent href="market:*" />
  </platform>
  <platform name="ios">
      <allow-intent href="itms:*" />
      <allow-intent href="itms-apps:*" />
  </platform>
</widget>