You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2018/09/12 02:14:25 UTC
svn commit: r1840621 - in /cordova/site/public:
docs/en/dev/config_ref/images.html
docs/en/dev/reference/cordova-cli/index.html
docs/en/dev/reference/cordova-plugin-statusbar/index.html feed.xml
Author: steven
Date: Wed Sep 12 02:14:25 2018
New Revision: 1840621
URL: http://svn.apache.org/viewvc?rev=1840621&view=rev
Log:
Updated docs
Modified:
cordova/site/public/docs/en/dev/config_ref/images.html
cordova/site/public/docs/en/dev/reference/cordova-cli/index.html
cordova/site/public/docs/en/dev/reference/cordova-plugin-statusbar/index.html
cordova/site/public/feed.xml
Modified: cordova/site/public/docs/en/dev/config_ref/images.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/config_ref/images.html?rev=1840621&r1=1840620&r2=1840621&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/config_ref/images.html (original)
+++ cordova/site/public/docs/en/dev/config_ref/images.html Wed Sep 12 02:14:25 2018
@@ -2478,7 +2478,7 @@ If you do not specify an icon, the Apach
</thead><tbody>
<tr>
<td>src</td>
-<td><em>Required</em> <br/> Location of the image file, relative to your project directory</td>
+<td><em>Required</em> <br/> Location of the image file, relative to your project directory.</td>
</tr>
<tr>
<td>platform</td>
@@ -2493,10 +2493,6 @@ If you do not specify an icon, the Apach
<td><em>Optional</em> <br/> Icon height in pixels</td>
</tr>
<tr>
-<td>density</td>
-<td><em>Optional</em> <br/> <mark>Android</mark> <br/> Specified icon density</td>
-</tr>
-<tr>
<td>target</td>
<td><em>Optional</em> <br/> <mark>Windows</mark> <br/> Destination filename for the image file and all its' MRT companions</td>
</tr>
@@ -2510,6 +2506,78 @@ which will be used for all platforms.</p
different screen resolutions.</p>
<h2>Android</h2>
+
+<p>On Android, instead of using a single image for an icon, you can use two images (background and foreground) to create an <strong>Adaptive Icon</strong>.</p>
+
+<table><thead>
+<tr>
+<th>Attributes</th>
+<th>Description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>background</td>
+<td><em>Required for Adaptive</em> <br/> Location of the image (png or vector) relative to your project directory, or color reference</td>
+</tr>
+<tr>
+<td>foreground</td>
+<td><em>Required for Adaptive</em> <br/> Location of the image (png or vector) relative to your project directory, or color reference</td>
+</tr>
+<tr>
+<td>density</td>
+<td><em>Optional</em> <br/> Specified icon density</td>
+</tr>
+</tbody></table>
+
+<h3>Adaptive Icons</h3>
+
+<p>To use the adaptive icons the <code>background</code> and <code>foreground</code> attributes must be defined in place of the <code>src</code> attribute. The <code>src</code> attribute is not used for adaptive icons.</p>
+
+<h4>Adaptive Icon with Images:</h4>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><platform</span> <span class="na">name=</span><span class="s">"android"</span><span class="nt">></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/ldpi-background.png"</span> <span class="na">density=</span><span class="s">"ldpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/ldpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/mdpi-background.png"</span> <span class="na">density=</span><span class="s">"mdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/mdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/hdpi-background.png"</span> <span class="na">density=</span><span class="s">"hdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/hdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xhdpi-background.png"</span> <span class="na">density=</span><span class="s">"xhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xhdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xxhdpi-background.png"</span> <span class="na">density=</span><span class="s">"xxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxhdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xxxhdpi-background.png"</span> <span class="na">density=</span><span class="s">"xxxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxxhdpi-foreground.png"</span> <span class="nt">/></span>
+<span class="nt"></platform></span>
+</code></pre></div>
+<p><strong>Note:</strong> In this example, the foreground image will also be used as the fallback icon for Android devices that do not support the adaptive icons. The fallback icon can be overridden by setting the src attribute.</p>
+
+<h4>Adaptive Icon with Vectors:</h4>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><platform</span> <span class="na">name=</span><span class="s">"android"</span><span class="nt">></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/ldpi-background.xml"</span> <span class="na">density=</span><span class="s">"ldpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/ldpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/ldpi.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/mdpi-background.xml"</span> <span class="na">density=</span><span class="s">"mdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/mdpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/mdpi.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/hdpi-background.xml"</span> <span class="na">density=</span><span class="s">"hdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/hdpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/hdpi.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xhdpi-background.xml"</span> <span class="na">density=</span><span class="s">"xhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xhdpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/xhdpi.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xxhdpi-background.xml"</span> <span class="na">density=</span><span class="s">"xxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxhdpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/xxhdpi.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"res/icon/android/xxxhdpi-background.xml"</span> <span class="na">density=</span><span class="s">"xxxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxxhdpi-foreground.xml"</span> <span class="na">src=</span><span class="s">"res/android/xxxhdpi.png"</span> <span class="nt">/></span>
+<span class="nt"></platform></span>
+</code></pre></div>
+<p><strong>Note:</strong> In this example, the src attribute must be defined when then foreground attribute is defined with a vector or color.</p>
+
+<h4>Adaptive Icon with Colors:</h4>
+
+<p>Create a <code>res/values/colors.xml</code> resource file in your project directory to store the app's color definitions.</p>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="cp"><?xml version="1.0" encoding="utf-8"?></span>
+<span class="nt"><resources></span>
+ <span class="nt"><color</span> <span class="na">name=</span><span class="s">"background"</span><span class="nt">></span>#FF0000<span class="nt"></color></span>
+<span class="nt"></resources></span>
+</code></pre></div>
+<p>In the <code>config.xml</code>, we will add <code>resource-file</code> to copy the <code>colors.xml</code> into the approprate location so that the colors are available during build time.</p>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><platform</span> <span class="na">name=</span><span class="s">"android"</span><span class="nt">></span>
+ <span class="nt"><resource-file</span> <span class="na">src=</span><span class="s">"res/values/colors.xml"</span> <span class="na">target=</span><span class="s">"/app/src/main/res/values/colors.xml"</span> <span class="nt">/></span>
+
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"ldpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/ldpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"mdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/mdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"hdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/hdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"xhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xhdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"xxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxhdpi-foreground.png"</span> <span class="nt">/></span>
+ <span class="nt"><icon</span> <span class="na">background=</span><span class="s">"@color/background"</span> <span class="na">density=</span><span class="s">"xxxhdpi"</span> <span class="na">foreground=</span><span class="s">"res/icon/android/xxxhdpi-foreground.png"</span> <span class="nt">/></span>
+<span class="nt"></platform></span>
+</code></pre></div>
+<h3>Standard Icons</h3>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"> <span class="nt"><platform</span> <span class="na">name=</span><span class="s">"android"</span><span class="nt">></span>
<span class="c"><!--
ldpi : 36x36 px
Modified: cordova/site/public/docs/en/dev/reference/cordova-cli/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/reference/cordova-cli/index.html?rev=1840621&r1=1840620&r2=1840621&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/reference/cordova-cli/index.html (original)
+++ cordova/site/public/docs/en/dev/reference/cordova-cli/index.html Wed Sep 12 02:14:25 2018
@@ -2613,7 +2613,7 @@ cordova create myApp com.myCompany.myApp
cd myApp
# Add camera plugin to the project and remember that in config.xml & package.json.
cordova plugin add cordova-plugin-camera
-# Add camera plugin to the project and remember that in config.xml and package.json.
+# Add camera plugin to the project and remember that in config.xml and package.json.
cordova plugin add cordova-plugin-camera
# Add android platform to the project and remember that in config.xml & package.json.
cordova platform add android
@@ -2922,7 +2922,7 @@ www/
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-bash" data-lang="bash">cordova <span class="o">{</span>plugin | plugins<span class="o">}</span> <span class="o">[</span>
- add <plugin-spec> <span class="o">[</span>..] <span class="o">{</span><span class="nt">--searchpath</span><span class="o">=</span><directory> | <span class="nt">--noregistry</span> | <span class="nt">--link</span> | <span class="nt">--save</span> | <span class="nt">--browserify</span> | <span class="nt">--force</span><span class="o">}</span> |
+ add <plugin-spec> <span class="o">[</span>..] <span class="o">{</span><span class="nt">--searchpath</span><span class="o">=</span><directory> | <span class="nt">--noregistry</span> | <span class="nt">--link</span> | <span class="nt">--save</span> | <span class="nt">--force</span><span class="o">}</span> |
<span class="o">{</span>remove | rm<span class="o">}</span> <span class="o">{</span><pluginid> | <name><span class="o">}</span> <span class="nt">--save</span> |
<span class="o">{</span>list | <span class="nb">ls</span><span class="o">}</span> |
save |
@@ -2962,11 +2962,6 @@ www/
</tr>
<tr>
<td></td>
-<td>--browserify</td>
-<td>Compile plugin JS at build time using browserify instead of runtime.</td>
-</tr>
-<tr>
-<td></td>
<td>--force</td>
<td><em>Introduced in version 6.1.</em> Forces copying source files from the plugin even if the same file already exists in the target directory.</td>
</tr>
@@ -3084,7 +3079,6 @@ copies plugin files for specified platfo
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-" data-lang="">cordova prepare [<platform> [..]]
- [--browserify]
</code></pre></div>
<h3>Options</h3>
@@ -3098,10 +3092,6 @@ copies plugin files for specified platfo
<td><code><platform> [..]</code></td>
<td>Platform name(s) to prepare. If not specified, all platforms are built.</td>
</tr>
-<tr>
-<td>--browserify</td>
-<td>Compile plugin JS at build time using browserify instead of runtime.</td>
-</tr>
</tbody></table>
<h2>cordova compile command</h2>
@@ -3116,7 +3106,6 @@ It only performs the compilation step wi
<span class="o">[</span><span class="nt">--debug</span>|--release]
<span class="o">[</span><span class="nt">--device</span>|--emulator|--target<span class="o">=</span><targetName>]
<span class="o">[</span><span class="nt">--buildConfig</span><span class="o">=</span><configfile>]
- <span class="o">[</span><span class="nt">--browserify</span><span class="o">]</span>
<span class="o">[</span><span class="nt">--</span> <platformOpts>]
</code></pre></div>
<p>For detailed documentation see <a href="#cordova-build-command">cordova build command</a> docs below.</p>
@@ -3132,7 +3121,6 @@ It only performs the compilation step wi
<span class="o">[</span><span class="nt">--debug</span>|--release]
<span class="o">[</span><span class="nt">--device</span>|--emulator]
<span class="o">[</span><span class="nt">--buildConfig</span><span class="o">=</span><configfile>]
- <span class="o">[</span><span class="nt">--browserify</span><span class="o">]</span>
<span class="o">[</span><span class="nt">--</span> <platformOpts>]
</code></pre></div>
<table><thead>
@@ -3166,10 +3154,6 @@ It only performs the compilation step wi
<td>Default: build.json in cordova root directory. <br/> Use the specified build configuration file. <code>build.json</code> file is used to specify paramaters to customize the app build process esecially related to signing the package.</td>
</tr>
<tr>
-<td>--browserify</td>
-<td>Compile plugin JS at build time using browserify instead of runtime</td>
-</tr>
-<tr>
<td><code><platformOpts></code></td>
<td>To provide platform specific options, you must include them after <code>--</code> separator. Review platform guide docs for more details.</td>
</tr>
@@ -3201,7 +3185,6 @@ It only performs the compilation step wi
<span class="o">[</span><span class="nt">--noprepare</span><span class="o">]</span> <span class="o">[</span><span class="nt">--nobuild</span><span class="o">]</span>
<span class="o">[</span><span class="nt">--device</span>|--emulator|--target<span class="o">=</span><targetName>]
<span class="o">[</span><span class="nt">--buildConfig</span><span class="o">=</span><configfile>]
- <span class="o">[</span><span class="nt">--browserify</span><span class="o">]</span>
<span class="o">[</span><span class="nt">--</span> <platformOpts>]
</code></pre></div>
<table><thead>
@@ -3251,10 +3234,6 @@ It only performs the compilation step wi
<td>Default: build.json in cordova root directory. <br/> Use the specified build configuration file. <code>build.json</code> file is used to specify paramaters to customize the app build process esecially related to signing the package.</td>
</tr>
<tr>
-<td>--browserify</td>
-<td>Compile plugin JS at build time using browserify instead of runtime</td>
-</tr>
-<tr>
<td><code><platformOpts></code></td>
<td>To provide platform specific options, you must include them after <code>--</code> separator. Review platform guide docs for more details.</td>
</tr>
@@ -3399,7 +3378,6 @@ cordova config delete <key>
</code></pre></div>
<h3>Examples</h3>
<div class="highlight"><pre><code class="language-" data-lang="">cordova config set autosave false
-cordova config set browserify false
</code></pre></div>
</div>
Modified: cordova/site/public/docs/en/dev/reference/cordova-plugin-statusbar/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/reference/cordova-plugin-statusbar/index.html?rev=1840621&r1=1840620&r2=1840621&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/reference/cordova-plugin-statusbar/index.html (original)
+++ cordova/site/public/docs/en/dev/reference/cordova-plugin-statusbar/index.html Wed Sep 12 02:14:25 2018
@@ -2552,7 +2552,9 @@
<span class="nx">StatusBar</span><span class="p">.</span><span class="nx">backgroundColorByHexString</span><span class="p">(</span><span class="s2">"#333"</span><span class="p">);</span>
<span class="p">}</span>
</code></pre></div>
-<p>It is also possible to make the status bar semi-transparent. For example, a black status bar with 20% opacity:</p>
+<p>It is also possible to make the status bar semi-transparent. Android uses hexadecimal ARGB values, which are formatted as #AARRGGBB. That first pair of letters, the AA, represent the alpha channel. You must convert your decimal opacity values to a hexadecimal value. You can read more about it <a href="https://stackoverflow.com/questions/5445085/understanding-colors-on-android-six-characters/11019879#11019879">here</a>.</p>
+
+<p>For example, a black status bar with 20% opacity:</p>
<div class="highlight"><pre><code class="language-js" data-lang="js"><span class="k">if</span> <span class="p">(</span><span class="nx">cordova</span><span class="p">.</span><span class="nx">platformId</span> <span class="o">==</span> <span class="s1">'android'</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">StatusBar</span><span class="p">.</span><span class="nx">overlaysWebView</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span>
<span class="nx">StatusBar</span><span class="p">.</span><span class="nx">backgroundColorByHexString</span><span class="p">(</span><span class="s1">'#33000000'</span><span class="p">);</span>
Modified: cordova/site/public/feed.xml
URL: http://svn.apache.org/viewvc/cordova/site/public/feed.xml?rev=1840621&r1=1840620&r2=1840621&view=diff
==============================================================================
--- cordova/site/public/feed.xml (original)
+++ cordova/site/public/feed.xml Wed Sep 12 02:14:25 2018
@@ -6,8 +6,8 @@
</description>
<link>https://cordova.apache.org/</link>
<atom:link href="https://cordova.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Wed, 05 Sep 2018 08:06:30 +0000</pubDate>
- <lastBuildDate>Wed, 05 Sep 2018 08:06:30 +0000</lastBuildDate>
+ <pubDate>Wed, 12 Sep 2018 01:49:38 +0000</pubDate>
+ <lastBuildDate>Wed, 12 Sep 2018 01:49:38 +0000</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org