Skip to content
This repository was archived by the owner on Jan 31, 2023. It is now read-only.

Commit dfdc5c5

Browse files
committed
Version 3.6.0
1 parent 790974c commit dfdc5c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+11851
-706
lines changed

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.5.0
1+
3.6.0

docs/en/3.6.0/config.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"language": "English",
3+
"merge": {
4+
"events.md": [
5+
"cordova/events/events.md",
6+
"cordova/events/events.deviceready.md",
7+
"cordova/events/events.pause.md",
8+
"cordova/events/events.resume.md",
9+
"cordova/events/events.backbutton.md",
10+
"cordova/events/events.menubutton.md",
11+
"cordova/events/events.searchbutton.md",
12+
"cordova/events/events.startcallbutton.md",
13+
"cordova/events/events.endcallbutton.md",
14+
"cordova/events/events.volumedownbutton.md",
15+
"cordova/events/events.volumeupbutton.md"
16+
]
17+
}
18+
}

docs/en/3.6.0/config_ref/images.md

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
---
2+
license: Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
---
19+
20+
# Icons and Splash Screens
21+
22+
This section shows how to configure an app's icon and optional splash
23+
screen for various platforms, both when working in the Cordova CLI
24+
(described in The Command-Line Interface) or using platform-specific
25+
SDK tools (detailed in the Platform Guides).
26+
27+
## Configuring Icons in the CLI
28+
29+
When working in the CLI you can define app icon(s) via `<icon>` element (`config.xml`).
30+
If you do not specify an icon then the Apache Cordova logo is used.
31+
32+
<icon src="res/ios/icon.png" platform="ios" width="57" height="57" density="mdpi" />
33+
34+
src: (required) specifies the location of the image file, relative to your project directory
35+
36+
platform: (optional) target platform
37+
38+
width: (optional) icon width in pixels
39+
40+
height: (optional) icon height in pixels
41+
42+
density: (optional) android specific, specifies icon density
43+
44+
The following configuration can be used to define single default icon
45+
which will be used for all platforms.
46+
47+
<icon src="res/icon.png" />
48+
49+
For each platform you can also define a pixel-perfect icons set to fit
50+
different screen resolutions.
51+
52+
Amazon Fire OS
53+
54+
<platform name="amazon-fireos">
55+
<icon src="res/android/ldpi.png" density="ldpi" />
56+
<icon src="res/android/mdpi.png" density="mdpi" />
57+
<icon src="res/android/hdpi.png" density="hdpi" />
58+
<icon src="res/android/xhdpi.png" density="xhdpi" />
59+
</platform>
60+
61+
Android
62+
63+
<platform name="android">
64+
<icon src="res/android/ldpi.png" density="ldpi" />
65+
<icon src="res/android/mdpi.png" density="mdpi" />
66+
<icon src="res/android/hdpi.png" density="hdpi" />
67+
<icon src="res/android/xhdpi.png" density="xhdpi" />
68+
</platform>
69+
70+
Blackberry10
71+
72+
<platform name="blackberry10">
73+
<icon src="res/bb10/icon-86.png" />
74+
<icon src="res/bb10/icon-150.png" />
75+
</platform>
76+
77+
See BlackBerry's documentation for targeting multiple sizes and locales.
78+
[http://developer.blackberry.com/html5/documentation/icon_element.html]
79+
80+
Firefox OS
81+
82+
<platform name="firefoxos">
83+
<icon src="res/ff/logo.png" width="60" height="60" />
84+
</platform>
85+
86+
iOS
87+
88+
<platform name="ios">
89+
<!-- iOS 7.0+ -->
90+
<!-- iPhone / iPod Touch -->
91+
<icon src="res/ios/icon-60.png" width="60" height="60" />
92+
<icon src="res/ios/icon-60@2x.png" width="120" height="120" />
93+
<!-- iPad -->
94+
<icon src="res/ios/icon-76.png" width="76" height="76" />
95+
<icon src="res/ios/icon-76@2x.png" width="152" height="152" />
96+
<!-- iOS 6.1 -->
97+
<!-- Spotlight Icon -->
98+
<icon src="res/ios/icon-40.png" width="40" height="40" />
99+
<icon src="res/ios/icon-40@2x.png" width="80" height="80" />
100+
<!-- iPhone / iPod Touch -->
101+
<icon src="res/ios/icon.png" width="57" height="57" />
102+
<icon src="res/ios/icon@2x.png" width="114" height="114" />
103+
<!-- iPad -->
104+
<icon src="res/ios/icon-72.png" width="72" height="72" />
105+
<icon src="res/ios/icon-72@2x.png" width="144" height="144" />
106+
<!-- iPhone Spotlight and Settings Icon -->
107+
<icon src="res/ios/icon-small.png" width="29" height="29" />
108+
<icon src="res/ios/icon-small@2x.png" width="58" height="58" />
109+
<!-- iPad Spotlight and Settings Icon -->
110+
<icon src="res/ios/icon-50.png" width="50" height="50" />
111+
<icon src="res/ios/icon-50@2x.png" width="100" height="100" />
112+
</platform>
113+
114+
Tizen
115+
116+
<platform name="tizen">
117+
<icon src="res/tizen/icon-128.png" width="128" height="128" />
118+
</platform>
119+
120+
Windows Phone8
121+
122+
<platform name="wp8">
123+
<icon src="res/wp/ApplicationIcon.png" width="99" height="99" />
124+
<!-- tile image -->
125+
<icon src="res/wp/Background.png" width="159" height="159" />
126+
</platform>
127+
128+
Windows8
129+
130+
<platform name="windows8">
131+
<icon src="res/windows8/logo.png" width="150" height="150" />
132+
<icon src="res/windows8/smalllogo.png" width="30" height="30" />
133+
<icon src="res/windows8/storelogo.png" width="50" height="50" />
134+
</platform>
135+
136+
## Configuring Splash Screens in the CLI
137+
138+
In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here.
139+
140+
# Example configuration
141+
142+
Please notice that the value of the "src" attribute is relative to the project directory and not to the www directory.
143+
You can name the source image whatever you like. The internal name in the app are determined by Cordova.
144+
145+
<platform name="android">
146+
<!-- you can use any density that exists in the Android project -->
147+
<splash src="res/screen/android/splash-land-hdpi.png" density="land-hdpi"/>
148+
<splash src="res/screen/android/splash-land-ldpi.png" density="land-ldpi"/>
149+
<splash src="res/screen/android/splash-land-mdpi.png" density="land-mdpi"/>
150+
<splash src="res/screen/android/splash-land-xhdpi.png" density="land-xhdpi"/>
151+
152+
<splash src="res/screen/android/splash-port-hdpi.png" density="port-hdpi"/>
153+
<splash src="res/screen/android/splash-port-ldpi.png" density="port-ldpi"/>
154+
<splash src="res/screen/android/splash-port-mdpi.png" density="port-mdpi"/>
155+
<splash src="res/screen/android/splash-port-xhdpi.png" density="port-xhdpi"/>
156+
</platform>
157+
158+
<platform name="ios">
159+
<!-- images are determined by width and height. The following are supported -->
160+
<splash src="res/screen/ios/Default~iphone.png" width="320" height="480"/>
161+
<splash src="res/screen/ios/Default@2x~iphone.png" width="640" height="960"/>
162+
<splash src="res/screen/ios/Default-Portrait~ipad.png" width="768" height="1024"/>
163+
<splash src="res/screen/ios/Default-Portrait@2x~ipad.png" width="1536" height="2048"/>
164+
<splash src="res/screen/ios/Default-Landscape~ipad.png" width="1024" height="768"/>
165+
<splash src="res/screen/ios/Default-Landscape@2x~ipad.png" width="2048" height="1536"/>
166+
<splash src="res/screen/ios/Default-568h@2x~iphone.png" width="640" height="1136"/>
167+
</platform>
168+
169+
<platform name="wp8">
170+
<!-- images are determined by width and height. The following are supported -->
171+
<splash src="res/screen/wp8/SplashScreenImage.jpg" width="768" height="1280"/>
172+
</platform>
173+
174+
<platform name="windows8">
175+
<!-- images are determined by width and height. The following are supported -->
176+
<splash src="res/screen/windows8/splashscreen.png" width="620" height="300"/>
177+
</platform>
178+
179+
<platform name="blackberry10">
180+
<!-- Add a rim:splash element for each resolution and locale you wish -->
181+
<!-- http://developer.blackberry.com/html5/documentation/rim_splash_element.html -->
182+
<rim:splash src="res/screen/windows8/splashscreen.png"/>
183+
</platform>
184+
185+
186+
<preference name="SplashScreenDelay" value="10000" />
187+
188+
# Supported platforms
189+
190+
As of now (Cordova 3.5.0 July 2014) the following platforms support splash screens.
191+
192+
android
193+
ios
194+
wp8
195+
windows8
196+
blackberry10
197+
198+
# Splashscreen Plugin
199+
200+
Apache Cordova also offers special splash screen plugin which could be used to programmatically display and hide a splash screen during application launch
201+
https://github.com/apache/cordova-plugin-splashscreen
202+
203+

0 commit comments

Comments
 (0)