Config.xml

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

Для проектов, созданных с помощью 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/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>

content

Определяет стартовую страницу приложения в каталоге веб-активов верхнего уровня. Значение по умолчанию — 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

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

Примеры:

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

plugin

Указывает информацию о плагине, который нужно восстановить во время этапа prepare. Этот элемент автоматически добавляется в проект 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, которое используется при восстановлении плагина во время этапа prepare. Этот элемент добавляется в config.xml при добавлении плагина, использующего переменные CLI, с флагом --save. Дополнительную информацию см. в справке CLI по добавлению плагинов.

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

Примеры:

<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" />

<!-- 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 и используете файл конфигурации platform-специфичный config.xml в качестве источника, вы используете тег для включения API уровня устройств и внешних плагинов. Они часто появляются со значениями пользовательских значений в platform-специфичных файлах config.xml. Для получения подробной информации о том, как указать каждую функцию, обратитесь к Справке по API. Для получения дополнительной информации о плагинах см. Руководство по разработке плагинов. ПРИМЕЧАНИЕ: В большинстве случаев этого не следует задавать напрямую.

параметр

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

Примеры:

<!-- 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>

платформа

При использовании командной строки для сборки приложений иногда необходимо указать предпочтения или другие элементы, специфичные для определённой платформы. Используйте элемент , чтобы указать конфигурацию, которая должна отображаться только в файлах 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>