DNET_CordovaConfigXml

Cordova - config.xml

• 戻る

概要

Cordova - config.xmlの設定

共通

#	項目名	概要
1	widget	・id:アプリの識別子 ・version:バージョン番号
2	name	アプリ名
3	description	アプリの概要
4	author	アプリの作成者
5	content	アプリ起動時、最初にロードするコンテンツ(index.htmlなど)。 ・外部のURL(http://・・・)で外部のコンテンツを表示できる。 ・外部のURLの場合は、下記ホワイトリストの指定が必要。
6	access	・ホワイトリスト指定（http://aaa.bbb.com、http://xxx.yyy.com）。 ・は制限なし。ドメイン指定も可能（http://.xxxx.com）。
7	preference	実行時のフレームワークの挙動を設定。 ・name:設定名 ・value:設定値
8	feature	プラグインの有効化
9	allow-intent	URLSchemeで別アプリを起動する際に予め定義。
10	platform	特定のプラットフォームのみに反映する場合に利用

• 参考
  • Config.xml - Apache Cordova
    http://cordova.apache.org/docs/en/dev/config_ref/index.html#The%20config.xml%20File
  • SampleProgram/config.xml at master · OpenTouryoProject/SampleProgram
    https://github.com/OpenTouryoProject/SampleProgram/tree/master/Template/MobileTemplate/CordovaTemplate/config.xml

Android（共通）

ShowTitle

画面の上部にタイトルを表示

• <preference name="ShowTitle" value="True" />

バージョン情報

• android-versionCode

  • <widget android-versionCode="" />

• android-SdkVersion

  • <preference name="android-minSdkVersion" value="" />
  • <preference name="android-maxSdkVersion" value="" />
  • <preference name="android-targetSdkVersion" value="" />

• 参考
  Androidのバージョン（Androidの該当節を参照）

参考（Android）

• Android の構成 - Apache Cordova
  https://cordova.apache.org/docs/ja/7.x/guide/platforms/android/config.html

iOS（共通）

参考（iOS）

• iOS 構成 - Apache Cordova
  https://cordova.apache.org/docs/ja/7.x/guide/platforms/ios/config.html

個別

上記の設定から、Prepareコマンド（Cordova (PhoneGap)の該当節を参照）により、

Platform、Pluginの設定が自動生成される。

Platformの構成

Androidの場合（Platform）

platforms/android/res/xml/config.xml

#	項目名	概要
1	loadingDialog	アプリの読み込み中に、ネイティブのロード中を表すダイアログ表示
2	loadingPageDialog	HTMLページの読み込み中に、ネイティブのロード中を表すダイアログを表示
3	errorUrl	アプリのエラーページ(wwwディレクトリからの相対パス)
4	backgroundColor	アプリの背景色を指定
5	loadUrlTimeoutValue	アプリの読み込みのタイムアウト値設定
6	keepRunning	・バックグラウンド実行の設定。 ・trueかfalseを指定。デフォルトはtrue（バックグラウンドでも実行）。
7	splashscreen	・splashscreenの画像 ・res/drawableディレクトリ以下・拡張子無し。
8	disallowOverscroll (boolean, defaults to false):	・オーバースクロール時の表現。 ・trueかfalseを指定。デフォルトはfalse（表現しない）。

iOSの場合（Platform）

platforms/ios/（アプリ名）/config.xml

#	項目名	概要
1	DisallowOverscroll	・オーバースクロール時の表現。 ・trueかfalseを指定。デフォルトはfalse（表現しない）。
2	TopActivityIndicator	・ステータスバーに表示されるインジケータの種類を設定。 ・有効な値は、whiteLargeとwhiteとgray。デフォルトはgray。
3	EnableViewportScale	・metaタグによるviewportのスケールの有効・無効。 ・trueかfalseを指定。デフォルトはfalse（metaタグでスケールする）。
4	AutoHideSplashScreen	・スプラッシュスクリーンを消すタイミングをJavaScriptから指定する・しない。 ・trueかfalseを指定。デフォルトはtrue（JavaScriptから指定しない）。
5	FadeSplashScreen	・スプラッシュスクリーンをフェードイン・フェードアウトさせるかどうか。 ・trueかfalseを指定。デフォルトはtrue（フェードイン・フェードアウトさせる）。
6	FadeSplashScreenDuration	・スプラッシュスクリーンのアニメーションの長さを秒数で指定。 ・デフォルトは2。小数点も指定可能。
7	ShowSplashScreenSpinner	・スプラッシュスクリーンの上にスピナー表示する・しない。 ・trueかfalseを指定。デフォルトはtrue（スピナー表示する）。
8	MediaPlaybackRequiresUserAction	・HTML5videoタグの自動再生を許可する・しない。 ・trueかfalseを指定。デフォルトはfalse（自動再生を許可する）。
9	AllowInlineMediaPlayback	・HTML5videoタグでのプレイバックを許可する・しない。 ・HTML側のvideoタグ属性にwebkit-playsinlineの追加が必要。 ・trueかfalseを指定します。デフォルトはfalse（自動再生を許可しない）。
10	BackupWebStorage	・Webストレージのバックアップ場所を設定。 ・noneとcloud（iCloud）とlocal（iTunes経由）のいずれかを指定。
11	KeyboardDisplayRequiresUserAction	・JavaScriptのfocusメソッドで、ソフトウェアキーボードを表示する・しない。 ・trueかfalseを指定。デフォルトはtrueです（表示しない）。
12	SuppressesIncrementalRendering	・すべてのビューを受け取ってからアプリ内部のHTMLをレンダリングする・しない。 ・trueかfalseを指定。デフォルトはfalse（すべてのビューを受け取ってからレンダリング）。
13	HideKeyboardFormAccessoryBar	・ソフトウェアキーボードの上に表示されるツールバーを表示する・しない。 ・trueかfalseを指定。デフォルトはfalse（表示する）。
14	KeyboardShrinksView	・ソフトウェアの大きさに合わせてWebViewの高さを変更する・しない。 ・trueかfalseを指定。デフォルトはfalse（変更しない）。

Pluginの構成

Cordova - Plugin

Androidの場合（Plugin）

platforms/android/res/xml/config.xml

iOSの場合（Plugin）

platforms/ios/（アプリ名）/config.xml

参考

• Config.xml ファイル - Apache Cordova
  https://cordova.apache.org/docs/ja/3.1.0/config_ref/index.html

移行メモ

• iOS の Platform 構成の表で、項番が % になっていた FadeSplashScreen の行を 「5」に修正した。
• 同じ表の BackupWebStorage の説明末尾にあった 「デフォルトはfalse（自動再生を許可しない）。」は、直前の AllowInlineMediaPlayback の説明の混入と判断して除去した （BackupWebStorage の既定値は cloud）。
• 元 Wiki では見出しそのものが他ページへのリンクになっていた箇所 （「Pluginの構成」）は、GitHub Wiki では見出しからアンカが生成されるため、 見出しをプレーン・テキストとし、リンクは直下の本文に置いた。
• 同名の見出し（「Android」「iOS」「参考」「Androidの場合」「iOSの場合」）が 複数あり GitHub Wiki でアンカが衝突するため、括弧で文脈を補って一意にした。
• 元 Wiki の &br; は <br> に置き換えた。
• PukiWiki のページ内アンカ（#xxxxxxxx）は GitHub Wiki では再現できないため、 同一ページ内のアンカは見出しから生成されるアンカに張り替え、 他ページのアンカを指すリンクは「〜（ページ名 の該当節を参照）」の形に置き換えた。

---

Tags: 移行, Cordova, PhoneGap, config.xml, Android, iOS, preference, splashscreen, ハイブリッドアプリ