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.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| id(строка) |
Обязательное поле Указывает обратный идентификатор домена приложения. |
| version(строка) |
Обязательное поле Полной номер версии, выраженный в формате major/minor/patch. |
| android-versionCode(строка) Android | Альтернативная версия для Android. Устанавливает код версии приложения. См. руководство по Android для получения информации о том, как можно изменить этот атрибут. |
| ios-CFBundleVersion(строка) iOS | Альтернативная версия для iOS. Более подробная информация доступна в документации по версиям iOS. |
| osx-CFBundleVersion(строка) OS X | Альтернативная версия для OS X. Более подробная информация доступна в документации по версиям OS X. |
| windows-packageVersion(строка) Windows | Альтернативная версия для Windows. Подробности см. в документации по версиям Windows |
| android-packageName(строка) Android | Альтернативное имя пакета для Android, переопределяет id. |
| ios-CFBundleIdentifier(строка) iOS | Альтернативный идентификатор пакета для iOS. Переопределяет id. |
| packageName(строка) Windows |
По умолчанию: Cordova.Example Имя пакета для Windows. |
| defaultlocale iOS Windows | Указывает язык по умолчанию приложения в соответствии с кодом языка IANA. |
| android-activityName(строка) Android | Установите имя активности для вашего приложения в AndroidManifest.xml. Обратите внимание, что это устанавливается только один раз после первого добавления платформы Android. |
| xmlns(строка) |
Обязательное поле Пространство имен для документа config.xml. |
| xmlns:cdv(строка) |
Обязательное поле Префикс пространства имен. |
Примеры:
<!-- 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>
автор
Указывает контактную информацию, которая может отображаться в списках приложений в магазинах.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| email(строка) |
Обязательное поле Электронная почта автора. |
| href(строка) |
Обязательное поле Веб-сайт автора. |
Примеры:
<widget ...> <author email="dev@cordova.apache.org" href="http://cordova.io"></author> </widget>
content
Определяет стартовую страницу приложения в каталоге веб-активов верхнего уровня. Значение по умолчанию — index.html, который обычно находится в корневом каталоге проекта www.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| src(строка) |
Обязательное поле Определяет стартовую страницу приложения в каталоге веб-активов верхнего уровня. Значение по умолчанию — index.html, которое обычно |
находится в корневом каталоге проекта www.
Примеры:
<widget ...> <content src="startPage.html"></content> </widget>
доступ
Определяет набор внешних доменов, с которыми приложение разрешено взаимодействовать. Значение по умолчанию, показанное выше, разрешает доступ к любому серверу. Подробности см. в руководстве по Белому списку доменов.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| origin(строка) |
Обязательное поле Определяет набор внешних доменов, с которыми приложение разрешено взаимодействовать. |
Значение по умолчанию, показанное выше, разрешает доступ к любому серверу. Подробности см. в руководстве по Белому списку доменов.
Примеры:
<widget ...> <access origin="*"></access> </widget> <widget ...> <access origin="http://google.com"></access> </widget>
разрешить навигацию
Управляет URL-адресами, к которым WebView может переходить. Применимо только к навигации верхнего уровня.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| href(строка) |
Обязательное поле Определяет набор внешних доменов, к которым 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-адреса не разрешены.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| href(строка) |
Обязательное поле Определяет URL-адреса, которые приложение разрешено открывать в системе. |
См. документацию cordova-plugin-whitelist для получения дополнительных сведений.
Примеры:
<allow-intent href="http://*/*" /> <allow-intent href="https://*/*" /> <allow-intent href="tel:*" /> <allow-intent href="sms:*" />
edit-config
См.
config-file
См.
engine
Указывает информацию о платформе, которую нужно восстановить во время этапа prepare.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| name(строка) |
Обязательное поле Название платформы, которую необходимо восстановить. |
| spec(строка) |
Обязательное поле Сведения о платформе, которую нужно восстановить. Это может быть major.minor.patch номер версии, каталог с платформой или URL, указывающий на репозиторий Git. Эта информация будет использоваться для получения кода платформы для восстановления из NPM, локального каталога или репозитория Git. Дополнительную информацию см. в разделе Спецификация платформы. |
Примеры:
<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 по добавлению плагинов.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| name(строка) |
Обязательное поле Название плагина, который нужно восстановить. |
| spec(строка) |
Обязательное поле Сведения о плагине, который нужно восстановить. Это может быть major.minor.patch номер версии, каталог с плагином или URL, указывающий на репозиторий Git. Эта информация будет использоваться для получения кода плагина для восстановления из NPM, локального каталога или репозитория Git. Дополнительную информацию см. в разделе Спецификация плагина. |
Примеры:
<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.
| Атрибуты (тип) Только для платформы: | Описание |
|---|---|
| name(строка) |
Обязательное поле Имя переменной CLI. Может содержать только заглавные буквы, цифры и символы подчеркивания. |
| value(строка) |
Обязательное поле Значение переменной CLI, которое будет использоваться при восстановлении родительского плагина во время этапа prepare. |
Примеры:
<plugin name="cordova-plugin-device" spec="^1.1.0">
<variable name="MY_VARIABLE" value="my_variable_value" />
</plugin>
настройка
Устанавливает различные параметры в виде пар имя/значение. Имя каждой настройки не зависит от регистра. Многие настройки уникальны для определенных платформ, и об этом будет указано.
| Атрибуты(тип) Только для платформы: | Описание |
|---|
| AllowInlineMediaPlayback(boolean) iOS |
По умолчанию: false Установите в значение true, чтобы разрешить воспроизведение HTML5-медиа встраиваемо в макет экрана, используя средства браузера вместо нативных средств. Для этого добавьте атрибут playsinline к элементам <video>. ПРИМЕЧАНИЕ: До iOS 10, элементы <video> должны использовать имя атрибута webkit-playsinline. |
| AndroidLaunchMode(string) Android |
По умолчанию: singleTop Разрешенные значения: standard, singleTop, singleTask, singleInstance Устанавливает атрибут Activity android:launchMode. Это изменяет поведение при запуске приложения из значка приложения или намерения, если приложение уже запущено. |
| android-maxSdkVersion(integer) Android |
По умолчанию: Не указано Устанавливает атрибут maxSdkVersion тега <uses-sdk> в файле манифеста проекта AndroidManifest.xml (см. здесь). |
| android-minSdkVersion(integer) Android |
По умолчанию: Зависит от версии cordova-android Устанавливает атрибут minSdkVersion тега <uses-sdk> в файле манифеста проекта AndroidManifest.xml (см. здесь). |
| android-targetSdkVersion(integer) Android |
По умолчанию: Зависит от версии cordova-android Устанавливает атрибут targetSdkVersion тега <uses-sdk> в файле манифеста проекта AndroidManifest.xml (см. здесь). |
| AppendUserAgent(string) Android iOS | Если установлено, значение будет добавлено в конец старого UserAgent веб-вью. При использовании с OverrideUserAgent, это значение будет проигнорировано. |
| BackgroundColor(string) Android iOS Windows | Устанавливает цвет фона приложения. Поддерживает четырехбайтовое шестнадцатеричное значение, где первый байт представляет альфа-канал, а следующие три байта — стандартные значения RGB. Для Windows альфа-канал игнорируется. Примечание: значение transparent установит фон плитки приложения на акцентный цвет в Windows. |
| BackupWebStorage(string) iOS |
По умолчанию: cloud Разрешенные значения: none, local, cloud. Установите в значение cloud, чтобы разрешить резервное копирование данных веб-хранилища через iCloud. Установите в значение local, чтобы разрешить только локальные резервные копии через синхронизацию iTunes. Установите в значение none, чтобы предотвратить резервные копии веб-хранилища. |
| CordovaWebViewEngine(string) iOS |
По умолчанию: CDVUIWebViewEngine Это устанавливает плагин движка WebView, который будет использоваться для рендеринга приложения. Плагин должен соответствовать протоколу CDVWebViewEngineProtocol. Значение здесь должно соответствовать имени "feature" плагина движка WebView, который установлен. Обычно это значение устанавливается плагином движка WebView автоматически. |
| CordovaDefaultWebViewEngine(string) iOS |
По умолчанию: CDVUIWebViewEngine Как и предыдущая настройка, CordovaWebViewEngine, это позволяет переопределить стандартный резервный WebView другим плагином. Стандартный WebView использует частный плагин CDVUIWebViewEngine. Вы можете переопределить его, если вам нужно использовать вместо него публичный плагин. Пример использования этой настройки — когда вам необходимо использовать что-то, кроме CDVUIWebViewEngine, для рендеринга приложения. Если установлены CordovaDefaultWebViewEngine и CordovaWebViewEngine, CordovaWebViewEngine будет выбран для рендеринга приложения для устройств с iOS 9 и выше, а CordovaDefaultWebViewEngine будет резервным вариантом для iOS 8. Плагин должен соответствовать протоколу CDVWebViewEngineProtocol. Значение здесь должно соответствовать имени "feature" плагина движка WebView, который установлен. |
| DefaultVolumeStream(string) Android |
По умолчанию: default Добавлено в cordova-android 3.7.0. Эта настройка устанавливает, к какому объему звука привязаны кнопки громкости устройства. По умолчанию это "call" для телефонов и "media" для планшетов. Установите значение "media", чтобы кнопки громкости всегда изменяли громкость медиа. Обратите внимание, что при использовании плагина медиа Cordova кнопки громкости будут динамически изменять управление на громкость медиа при активации любых объектов Media. |
| DisallowOverscroll(boolean) iOS Android |
По умолчанию: false Установите в true, если не хотите, чтобы интерфейс отображал обратную связь при прокрутке за начало или конец содержимого. На iOS жесты перепрокрутки вызывают отскок содержимого в исходное положение. На Android они производят более тонкий эффект мерцания по верхнему или нижнему краю содержимого. |
| EnableViewportScale(boolean) iOS |
По умолчанию: false Установите в значение true, чтобы разрешить тегу viewport мета-тег отключить или ограничить диапазон масштабирования пользователя, который по умолчанию включен. Разместите тег viewport, такой как следующий, в HTML для отключения масштабирования и гибкой подгонки содержимого в рендеринге WebView: <meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=no' />
|
| EnableWebGL(boolean) OS X |
По умолчанию: false (OS X 4.0.0+) Установите в значение true, чтобы включить WebGL в веб-вью. |
| ErrorUrl(URL) Android |
По умолчанию: null Если установлено, при ошибке в приложении будет отображена ссылка на указанную страницу вместо диалогового окна с заголовком "Ошибка приложения". |
| ErrorUrl(string) iOS | Если установлено, при ошибке в приложении будет отображена ссылка на локальную страницу. |
| ForegroundText(string) Windows |
По умолчанию: "light" Работает только для проектов Windows 8.1. Разрешенные значения: "light", "dark". Установите "dark", если вы используете BackgroundColor="white" или другой светлый цвет, чтобы избежать ошибок при отправке в магазин Windows. |
| FullScreen(boolean) Android |
По умолчанию: false Позволяет скрыть строку состояния в верхней части экрана. Примечание: Рекомендуемый платформенно-независимый способ достижения этого — использование плагина StatusBar. |
| GapBetweenPages(float) iOS |
По умолчанию: 0 Размер отступа в пунктах между страницами. |
| HideMousePointer(integer) OS X |
По умолчанию: -1 (OS X 4.0.0+) Устанавливает тайм-аут для скрытия указателя мыши. Установите в 0 для немедленного, в -1 для никогда. |
| InAppBrowserStorageEnabled (boolean) Android |
По умолчанию: true Управляет тем, могут ли страницы, открытые в InAppBrowser, получать доступ к тому же хранилищу localStorage и WebSQL, что и страницы, открытые в стандартном браузере. |
| KeepRunning(boolean) Android |
По умолчанию: true Определяет, остаётся ли приложение активным в фоновом режиме даже после срабатывания события pause. Установка значения false не завершает работу приложения после события pause, а просто останавливает выполнение кода в рамках веб-вью cordova, пока приложение находится в фоновом режиме. |
| KeyboardDisplayRequiresUserAction(boolean) iOS |
По умолчанию: true Установите в false, чтобы разрешить отображению клавиатуры при вызове focus() для элементов ввода формы. |
| LoadUrlTimeoutValue(number in milliseconds) Android |
По умолчанию: 20000, 20 секунд Время ожидания при загрузке страницы перед выбросом ошибки таймаута. |
| LoadingDialog(string) Android |
По умолчанию: null Если установлено, отображает диалог со заданным заголовком и сообщением, а также спиннер при загрузке первой страницы приложения. Заголовок и сообщение разделены запятой в этой строке значения, и эта запятая удаляется перед отображением диалогового окна. |
| LogLevel(string) Android |
По умолчанию: DEBUG Разрешенные значения: ERROR, WARN, INFO, DEBUG, VERBOSE Устанавливает минимальный уровень логирования, который будет фильтровать сообщения из вашего приложения. |
| MediaPlaybackAllowsAirPlay(boolean) iOS |
По умолчанию: true Установите в false, чтобы предотвратить использование AirPlay в этом представлении. Доступно в стандартном UIWebView и WKWebView. |
| MediaPlaybackRequiresUserAction(boolean) iOS |
По умолчанию: false Установите в true, чтобы предотвратить автоматическое воспроизведение HTML5-видео или аудио с атрибутом autoplay или через JavaScript. |
| Min/Max Version(Regex) Windows | Разрешенные значения: /(Microsoft.+? | Windows.+?)-(MinVersion | MaxVersionTested)/i Определяет экосистемы и их минимальные/максимальные версии, с которыми совместимо приложение. В каждом значении три части: SDK, ограничение версии и значение версии. Эти настройки обнаруживаются, начиная с Windows или Microsoft и заканчивающихся на -MinVersion или -MaxVersionTested:
Примечание: Эти настройки устанавливаются только в файлах appxmanifest целевой платформы, а не в файлах jsproj. |
| Orientation(string) |
По умолчанию: default Разрешенные значения: default, landscape, portrait Позволяет заблокировать ориентацию и предотвратить поворот интерфейса в ответ на изменения ориентации. ПРИМЕЧАНИЕ: Значение по умолчанию означает, что Cordova удалит запись предпочтения ориентации из файла манифеста/конфигурации платформы, позволяя платформе вернуться к своему поведению по умолчанию. Для iOS, чтобы указать режимы портрета и ландшафта, необходимо использовать платформное значение 'all'. |
| OSXLocalStoragePath(строка) OS X |
По умолчанию: ~/Library/Application Support/{bundle.id} (OS X 4.0.0+) Устанавливает каталог для локального хранилища. |
| OverrideUserAgent(строка) Android iOS | Если установлено, значение заменит старый UserAgent веб-вью. Это полезно для идентификации запроса из приложения/браузера при запросе удаленных страниц. Используйте с осторожностью, это может вызвать проблемы совместимости с веб-серверами. В большинстве случаев используйте AppendUserAgent вместо этого. |
| PageLength(вещественное число) iOS |
По умолчанию: 0 Размер каждой страницы в пунктах в направлении потока страниц. Когда PaginationMode — справа налево или слева направо, это свойство представляет ширину каждой страницы. Когда PaginationMode — сверху вниз или снизу вверх, это свойство представляет высоту каждой страницы. Значение по умолчанию — 0, что означает, что макет использует размер области просмотра для определения размеров страницы. |
| PaginationBreakingMode(строка) iOS |
По умолчанию: page Допустимые значения: page, column Допустимые значения — page и column. Способ, которым происходит разбиение колонок или страниц. Это свойство определяет, будут ли соблюдаться определенные свойства CSS, относящиеся к разбиению колонок и страниц, или игнорироваться. Если это свойство установлено в column, содержимое учитывает свойства CSS, относящиеся к разбиению колонок, вместо разбиения страниц. |
| PaginationMode(строка) iOS |
По умолчанию: unpaginated Допустимые значения: unpaginated, leftToRight, topToBottom, bottomToTop, rightToLeft Это свойство определяет, разбивается ли содержимое в веб-вью на страницы, которые заполняют область просмотра по одной экрану за раз, или отображается как одно длинное прокручиваемое представление. Если установлено значение для постраничного отображения, это свойство включает постраничный макет для содержимого, заставляя веб-вью использовать значения PageLength и GapBetweenPages для повторного макета содержимого. |
| SetFullscreen(булево) Android |
По умолчанию: false То же, что и параметр Fullscreen в глобальной конфигурации этого файла xml. Этот специфичный для Android элемент устарел в пользу глобального элемента Fullscreen и будет удален в будущей версии. |
| ShowTitle(булево) Android |
По умолчанию: false Отобразить заголовок в верхней части экрана. |
| SplashScreenBackgroundColor Windows |
По умолчанию: #464646 Устанавливает цвет фона экрана запуска. Поддерживает имя цвета CSS или четырехбайтовое шестнадцатеричное значение, где первый байт представляет альфа-канал, а следующие три — стандартные значения RGB. Альфа-канал игнорируется, хотя значение transparent вызовет черный/белый цвет фона в зависимости от темной/светлой темы соответственно. |
| Suppresses3DTouchGesture(булево) iOS |
По умолчанию: false Установите в значение true, чтобы избежать отображения инструмента увеличительного стекла на устройствах iOS, поддерживающих 3D Touch, когда пользователь применяет силу при длительном нажатии на веб-вью. Тщательно протестируйте приложение, так как это отключит обработчики onclick, но будет нормально работать с ontouchend. Если это значение true, SuppressesLongPressGesture будет фактически true. |
| SuppressesIncrementalRendering(булево) iOS |
По умолчанию: false Установите в значение true, чтобы подождать, пока все содержимое не будет получено, прежде чем оно будет отображено на экране. |
| SuppressesLongPressGesture(булево) iOS |
По умолчанию: false Установите в значение true, чтобы избежать отображения инструмента увеличительного стекла на iOS 9+ при длительном нажатии на веб-вью. Тщательно протестируйте приложение, так как это может повлиять на возможности выделения текста. |
| SwiftVersion(строка) iOS |
По умолчанию: (пустое) Установите для указания версии Swift. |
| TopActivityIndicator(строка) iOS |
По умолчанию: gray Допустимые значения: whiteLarge, white, gray. Управляет внешним видом маленькой вращающейся иконки в строке состояния, которая указывает на значительную активность процессора. |
| uap-target-min-version(строка) Windows | Это свойство устанавливает MinTargetVersion для Windows UAP. Если не указано, оно устанавливается в версию первоначального выпуска 10.0.10240.0 Примечание: Эта настройка задается в файле jsproj, а не в файле appxmanifest. Поэтому пользователи с версией ОС ниже этого значения не смогут запустить приложение. |
| UIWebViewDecelerationSpeed(строка) iOS |
По умолчанию: normal Допустимые значения: normal, fast Это свойство управляет скоростью замедления импульсной прокрутки. normal — стандартная скорость для большинства собственных приложений, а fast — для Mobile Safari. |
| WindowSize(строка) OS X |
По умолчанию: auto (OS X 4.0.0+) Устанавливает размер окна приложения. Принимает формат WxH для определенной ширины и высоты или специальные значения auto и fullscreen. Последние откроют окно без рамок, занимающее всю область рабочего стола. Обратите внимание, что это отличается от обычного полноэкранного режима OS X, который никогда не охватывает несколько дисплеев. Примечание: Глобальная настройка cordova fullscreen не имеет эффекта в OS X. |
| WindowsDefaultUriPrefix(строка) Windows | Допустимые значения: ms-appx://, ms-appx-web:// Определяет, хотите ли вы, чтобы ваше приложение нацеливалось на локальный контекст или удаленный контекст в качестве начального URI. При создании для Windows 10 значение по умолчанию — удаленный контекст ( ms-appx-web://). Чтобы иметь приложение в локальном режиме, которое не будет затронуто ограничениями удаленного режима, необходимо установить эту настройку в ms-appx:// и не объявлять никаких <access> элементов с удаленными URI. Локальный режим является значением по умолчанию для Windows 8.1 |
| WindowsStoreDisplayName(строка) Windows | Дружественное имя издателя, которое может быть отображено пользователям. |
| WindowsStoreIdentityName(строка) Windows | Имя идентификатора, используемое для магазина Windows. Идентификатор определяет глобально уникальный идентификатор пакета. Идентификатор пакета представлен кортежем атрибутов пакета. Подробности см. на странице идентификатора в справочнике по схеме манифеста пакета. |
| WindowsStorePublisherName(строка) Windows | Имя издателя для отображения. |
| WindowsToastCapable(булево) Windows |
По умолчанию: false Значение true указывает, что приложение может предоставлять уведомления «toast». |
| deployment-target(строка) iOS | Это устанавливает IPHONEOSDEPLOYMENTTARGET в сборке, что в конечном итоге переводится в MinimumOSVersion в ipa. Более подробную информацию см. в документации Apple по настройкам Deployment Target |
| target-device(строка) iOS |
По умолчанию: universal Допустимые значения: handset, tablet, universal Это свойство напрямую соответствует TARGETEDDEVICEFAMILY в проекте Xcode. Обратите внимание, что если вы нацеливаетесь на универсальный режим (который является значением по умолчанию), вам необходимо предоставить снимки экрана как для iPhone, так и для iPad, иначе ваше приложение может быть отклонено. |
| windows-phone-target-version(строка) Windows | Устанавливает версию Windows Phone, на которую будет нацелен пакет (полученный из cordova build). Если не указано, она будет установлена в ту же версию, что и windows-target-version (если найдена). |
| windows-target-version(строка) Windows | Устанавливает версию Windows, на которую будет нацелен пакет (полученный из cordova build). Если не указано, будет установлено значение '8.1'. |
Примеры:
<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, поэтому элемент
| Атрибуты(тип) Только для платформы: | Описание |
|---|---|
| name(строка) |
Обязательно Название плагина для включения. |
параметр
Используется для указания определенных параметров плагина, таких как: пакет, из которого извлекается код плагина, и необходимо ли инициализировать код плагина во время инициализации Webview.
| Атрибуты(тип) Только для платформы: | Описание |
|---|---|
| name(строка) iOS OS X Android |
Обязательно Допустимые значения: android-package, ios-package, osx-package, onload. 'ios-package', 'osx-package' и 'android-package' используются для указания имени пакета (как указано атрибутом 'value') для инициализации кода плагина, а 'onload' используется для указания того, должен ли соответствующий плагин (как указано в атрибуте 'value') быть инициализирован при инициализации контроллера. |
| value(строка или булево) iOS OS X Android |
Обязательно Указывает имя пакета, который будет использоваться для инициализации кода плагина (когда атрибут 'name' — android-package, ios-package или osx-package), указывает имя плагина, который должен загружаться во время инициализации контроллера (когда атрибут 'name' установлен в 'onload'). |
Примеры:
<!-- 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>
платформа
При использовании командной строки для сборки приложений иногда необходимо указать настройки или другие элементы, специфичные для определенной платформы. Используйте элемент
| Атрибуты(тип) Только для платформы: | Описание |
|---|---|
| name(строка) |
Обязательно Платформа, для которой определяются настройки. |
Примеры:
<platform name="android"> <preference name="Fullscreen" value="true" /> </platform>
зацеп
Представляет ваш пользовательский скрипт, который будет вызван Cordova при определённом действии (например, после добавления плагина или вызова логики подготовки платформы). Это полезно, когда вам нужно расширить стандартную функциональность Cordova. См. Руководство по хукам для получения дополнительной информации.
| Атрибуты(тип) Только для платформы: | Описание |
|---|---|
| type(строка) |
Обязательно Указывает действие, при котором должен быть вызван пользовательский скрипт. |
| src(строка) |
Обязательно Указывает расположение скрипта, который нужно вызвать при определённом действии. |
Примеры:
<hook type="after_plugin_install" src="scripts/afterPluginInstall.js" />
файл-ресурс
Этот тег устанавливает файлы ресурсов на вашу платформу и аналогичен такому же тегу в plugin.xml. Этот тег в настоящее время поддерживается только на cordova-ios@4.4.0 или более поздних версиях и cordova-android@6.2.1 или более поздних версиях.
| Атрибуты(тип) Только для платформы: | Описание |
|---|---|
| src(строка) iOS Android |
Обязательно Расположение файла относительно config.xml. |
| target(строка) | Путь, куда будет скопирован файл в вашем каталоге. |
Примеры:
Для 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>
© 2012, 2013, 2015 The Apache Software Foundation
Licensed under the Apache License 2.0.
https://cordova.apache.org/docs/en/9.x/config_ref/index.html
