This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/cordova-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4b79ced478 Deploying to asf-site from @
apache/cordova-docs@2a8c46a936619ee94948463c0135eefc70bd936d 🚀
4b79ced478 is described below
commit 4b79ced47832e7b6e9b9460e86a9fefcf91a1d9d
Author: erisu <[email protected]>
AuthorDate: Fri May 26 12:39:56 2023 +0000
Deploying to asf-site from @
apache/cordova-docs@2a8c46a936619ee94948463c0135eefc70bd936d 🚀
---
docs/en/dev/guide/next/index.html | 119 ++++++++++++++++++++++++--------------
feed.xml | 4 +-
2 files changed, 79 insertions(+), 44 deletions(-)
diff --git a/docs/en/dev/guide/next/index.html
b/docs/en/dev/guide/next/index.html
index 85328ae865..30628e2888 100644
--- a/docs/en/dev/guide/next/index.html
+++ b/docs/en/dev/guide/next/index.html
@@ -2280,9 +2280,9 @@
<p>For developers who have an understanding of how to use the Cordova CLI and
make use of plugins, there are a few things you may want to consider
researching next to build better, more performant Cordova applications. The
following document offers advice on various topics relating to best practices,
testing, upgrades, and other topics, but is not meant to be prescriptive.
Consider this your launching point for your growth as a Cordova developer.
Also, if you see something that can be im [...]
-<h1>Best Practices for Cordova Apps</h1>
+<h2>Best Practices for Cordova Apps</h2>
-<h2>1) SPA Is Your Friend</h2>
+<h3>1) SPA Is Your Friend</h3>
<p>First and foremost - your Cordova applications should adopt the SPA (Single
Page Application) design. Loosely defined, a SPA is a client-side application
that is run from one request of a web page. The user loads an initial set of
resources (HTML, CSS, and JavaScript) and further updates (showing a new view,
loading data) is done via XHR requests. SPAs are commonly used for more complex
client-side applications. Gmail is a great example of this. After you load
Gmail, mail views, editi [...]
@@ -2293,50 +2293,57 @@
<p>Examples of SPA libraries you can use in your Cordova applications are:</p>
<ul>
- <li><a href="https://reactjs.org";>ReactJS</a></li>
- <li><a href="https://vuejs.org/";>Vue</a></li>
+ <li><a href="https://react.dev/";>React</a></li>
+ <li><a href="https://vuejs.org/";>Vue.js</a></li>
<li><a href="https://angular.io/";>Angular</a></li>
- <li><a href="https://emberjs.com";>EmberJS</a></li>
- <li><a href="https://backbonejs.org";>Backbone</a></li>
+ <li><a href="https://emberjs.com/";>Ember.js</a></li>
+ <li><a href="https://backbonejs.org/";>Backbone.js</a></li>
<li><a href="https://www.telerik.com/kendo-ui";>Kendo UI</a></li>
<li><a href="https://onsen.io";>Onsen UI</a></li>
- <li><a href="https://www.sencha.com/products/extjs/";>Sencha Ext JS</a></li>
</ul>
<p>And many, many, more.</p>
-<h2>2) Performance Considerations</h2>
+<h3>2) Performance Considerations</h3>
<p>Consider the following issues to improve the performance in your mobile
applications:</p>
-<p><strong>Click versus Touch</strong> - Many devices impose a 300ms delay on
click events in order to distinguish between a tap and tap-to-zoom gesture.
This can have the effect of making your app feel slow and unresponsive.
Avoiding this delay is one of the most important ways of improving your
app's perceived performance. For more information on the tap delay, see <a
href="https://developers.google.com/web/updates/2013/12/300ms-tap-delay-gone-away";>300ms
tap delay, gone away</a> o [...]
+<ul>
+ <li>
+ <p><strong>Click vs. Touch</strong></p>
-<p>Most Android versions no longer impose this delay, but iOS by default still
does. For iOS, using <a
href="https://github.com/apache/cordova-plugin-wkwebview-engine";>WkWebView</a>
instead of the default UIWebView gets rid of this delay. For both Android and
iOS, you must ensure that your viewport meta tag has at least
<code>width=device-width</code>, or you will still have the tap delay. If you
need to support older devices (Android 4.4 or iOS 8), consider a polyfill such
as <a href="h [...]
+ <p>Many devices impose a 300ms delay on click events in order to
distinguish between a tap and tap-to-zoom gesture. This can have the effect of
making your app feel slow and unresponsive. Avoiding this delay is one of the
most important ways of improving your app's perceived performance.</p>
-<p><strong>CSS Transitions versus DOM Manipulation</strong> - Using hardware
accelerated CSS transitions will be dramatically better than using JavaScript
to create animations. See the list of resources at the end of this section for
examples.</p>
+ <p>For more information on the tap delay, see <a
href="https://developer.chrome.com/blog/300ms-tap-delay-gone-away/";>300ms tap
delay, gone away</a> on the Google Developer site.</p>
-<p><strong>Networks Suck</strong> - Ok, networks don't always suck, but
the latency of mobile networks, even good mobile networks, is far worse than
you probably think. A desktop app that slurps down 500 rows of JSON data, every
30 seconds, will be both slower on a mobile device as well as a battery hog.
Keep in mind that Cordova apps have multiple ways to persist data in the app
(LocalStorage and the file system for example). Cache that data locally and be
aware of the amount of dat [...]
+ <p>As of 2015, most Android and iOS devices no longer imposes the delay.
For both Android and iOS, ensure that your viewport meta tag has set the
<code>width=device-width</code> value or you will still have the tap delay.</p>
+ </li>
+ <li>
+ <p><strong>CSS Transitions vs. DOM Manipulation</strong></p>
-<p><strong>Additional Performance Articles and Resources</strong></p>
+ <p>Using hardware accelerated CSS transitions will be dramatically better
than using JavaScript to create animations. See the list of resources at the
end of this section for examples.</p>
+ </li>
+ <li>
+ <p><strong>Network</strong></p>
-<ul>
- <li><a href="https://channel9.msdn.com/Events/Build/2013/4-313";>"Fast
Apps and Sites with JavaScript"</a></li>
+ <p>Latency of mobile networks, even good mobile networks, is far worse
than you probably think. A desktop app that slurps down 500 rows of JSON data,
every 30 seconds, will be both slower on a mobile device as well as a battery
hog. Keep in mind that Cordova apps have multiple ways to persist data in the
app (LocalStorage and the file system for example). Cache that data locally and
be aware of the amount of data you are sending back and forth. This is an
especially important conside [...]
+ </li>
</ul>
-<h2>3) Recognize and Handle Offline Status</h2>
+<h3>3) Recognize and Handle Offline Status</h3>
<p>See the previous tip about networks. Not only can you be on a slow network,
it is entirely possible for your application to be completely offline. Your
application should handle this in an intelligent manner. If your application
does not, people will think your application is broken. Given how easy it is to
handle (Cordova supports listening for both an offline and online event), there
is absolutely no reason for your application to not respond well when run
offline. Be sure to test ( [...]
<p>Note that the online and offline events, as well as the Network Connection
API, is not perfect. You may need to rely on using an XHR request to see if the
device is truly offline or online. At the end of the day, be sure add some form
of support for network issues - in fact, the Apple store (and probably other
stores) will reject apps that don't properly handle offline/online states.
For more discussion on this topic, see
<a href="https://www.telerik.com/blogs/is-this-thing-on-%28part-1%29";>"Is
This Thing On?"</a></p>
-<h1>Handling Upgrades</h1>
+<h2>Handling Upgrades</h2>
-<h2>Upgrading Cordova Projects</h2>
+<h3>Upgrading Cordova Projects</h3>
<p>There is no upgrade command for Cordova projects. Instead, remove the
platform from your project, and re-add it to get the latest version:</p>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>cordova platform rm android
+<div class="language-bash highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>cordova platform <span class="nb">rm </span>android
cordova platform add android
</code></pre></div></div>
@@ -2344,12 +2351,13 @@ cordova platform add android
<p>Note: some plugins may not be compatible with the new version of Cordova.
If a plugin is not compatible, you may be able to find a replacement plugin
that does what you need, or you may need to delay upgrading your project.
Alternatively, alter the plugin so that it does work under the new version and
contribute back to the community.</p>
-<h2>Plugin Upgrades</h2>
+<h3>Plugin Upgrades</h3>
<p>Upgrading plugins involves the same process as platforms - remove it, then
re-add it.</p>
-<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>cordova plugin rm some-plugin
+<div class="language-bash highlighter-rouge"><div class="highlight"><pre
class="highlight"><code>cordova plugin <span class="nb">rm </span>some-plugin
cordova plugin add some-plugin
</code></pre></div></div>
+
<p>Refer to <a href="../../platform_plugin_versioning_ref/index.html">Manage
versions and platforms</a> for more details.</p>
<p>Be sure to check the updated plugin's documentation, as you may need to
adjust your code to work with the new version. Also, double check that the new
version of the plugin works with your project's version of Cordova.</p>
@@ -2358,11 +2366,11 @@ cordova plugin add some-plugin
<p>If your project has a lot of plugins that you need updated, it might save
time to create a shell or batch script that removes and adds the plugins with
one command.</p>
-<h1>Testing Cordova apps</h1>
+<h2>Testing Cordova apps</h2>
<p>Testing your applications is super important. The Cordova team uses <a
href="https://jasmine.github.io/";>Jasmine</a>, but any web-friendly unit
testing solution will do.</p>
-<h2>Testing on a simulator vs. on a real device</h2>
+<h3>Testing on a simulator vs. on a real device</h3>
<p>It's not uncommon to use desktop browsers and device
simulators/emulators when developing a Cordova application. However, it is
incredibly important that you test your app on as many physical devices as you
possibly can:</p>
@@ -2376,21 +2384,24 @@ cordova plugin add some-plugin
<p>It is, of course, impossible to test on every possible device on the
market. For this reason, it's wise to recruit many testers who have
different devices. Although they won't catch every problem, chances are
good that they will discover quirks and issues that you would never find
alone.</p>
-<h1>Debugging Cordova apps</h1>
+<h2>Debugging Cordova apps</h2>
<p>In most cases, debugging Cordova apps is quite straightforward.</p>
-<h2>iOS Debugging</h2>
+<h3>iOS Debugging</h3>
+
+<h4>Xcode</h4>
-<h3>Xcode</h3>
<p>With Xcode you can debug the iOS native side of your Cordova application.
Make sure the Debug Area is showing (View -> Debug Area). Once your app is
running on the device (or simulator), you can view log output in the debug
area. This is where any errors or warnings will print. You can also set
breakpoints within the source files. This will allow you to step through the
code one line at a time and view the state of the variables at that time. The
state of the variables is shown in [...]
-<h3>Safari Remote Debugging with Web Inspector</h3>
+<h4>Safari Remote Debugging with Web Inspector</h4>
+
<p>With Safari's web inspector you can debug the webview and js code in
your Cordova application. This works only on macOS. It uses Safari to connect
to your device (or the simulator) and will connect the browser's dev tools
to the Cordova application. You get what you expect from dev tools - DOM
inspection/manipulation, a JavaScript debugger, network inspection, the
console, and more. Like Xcode, with Safari's web inspector you can set
breakpoints in the JavaScript code and [...]
<p>To start inspecting, first enable it on device at <code>Settings >
Safari > Advanced > Web Inspector</code>. On your desktop, enable the
developer tools from <code>Safari > Preferences > Advanced > Show
Develop menu in menu bar</code>. In the <code>Develop</code> menu, you will now
be able to select the connected device, and the app you want to inspect.</p>
-<h2>Chrome Remote Debugging</h2>
+<h4>Chrome Remote Debugging</h4>
+
<p>Virtually the same as the Safari version, this works with Android only but
can be used from any desktop operating system. Once connected, you get the same
Chrome Dev Tools experience for your mobile applications as you do with your
desktop applications. Even better, the Chrome Dev Tools have a mirror option
that shows your app running on the mobile device. This is more than just a view
- you can scroll and click from dev tools and it updates on the mobile
device.</p>
<p>To inspect, simply open up the URL <code>chrome://inspect</code> in Chrome
on your desktop. Here you will see a list of connected devices and inspectable
apps. Your device must be set up for USB debugging for this to work. Full
instructions on getting set up can be found at <a
href="https://developers.google.com/chrome/mobile/docs/debugging";>https://developers.google.com/chrome/mobile/docs/debugging</a>.</p>
@@ -2399,7 +2410,7 @@ cordova plugin add some-plugin
<p>It is also possible to use Chrome Dev Tools to inspect iOS apps, through a
WebKit proxy: <a
href="https://github.com/google/ios-webkit-debug-proxy/";>https://github.com/google/ios-webkit-debug-proxy/</a></p>
-<h1>User Interface</h1>
+<h2>User Interface</h2>
<p>Building a Cordova application that looks nice on mobile can be a
challenge, especially for developers. Many people chose to use a UI framework
to make this easier. Here is a short list of options you may want to
consider.</p>
@@ -2417,24 +2428,23 @@ cordova plugin add some-plugin
<ul>
<li><a
href="https://developer.apple.com/design/human-interface-guidelines/ios/overview/themes/";>iOS</a></li>
<li><a href="https://developer.android.com/design/";>Android</a></li>
- <li><a
href="https://developer.microsoft.com/en-us/windows/apps/design";>Windows
Phone</a></li>
</ul>
-<h1>Special Considerations</h1>
+<h2>Special Considerations</h2>
<p>Although Cordova makes cross-platform development easier, it's just not
possible to provide 100% isolation from the underlying native platform, so do
be aware of restrictions.</p>
-<h2>Platform Quirks</h2>
+<h3>Platform Quirks</h3>
<p>While reading the documentation, look for sections which outline different
behaviors or requirements on multiple platforms. If present, these would be in
a section titled "Android Quirks", "iOS Quirks", etc. Read
through these quirks and be aware of them as you work with Cordova.</p>
-<h2>Loading Remote Content</h2>
+<h3>Loading Remote Content</h3>
<p>Invoking Cordova JavaScript functions from a remotely-loaded HTML page (an
HTML page not stored locally on the device) is an unsupported configuration.
This is because Cordova was not designed for this, and the Apache Cordova
community does no testing of this configuration. While it can work in some
circumstances, it is not recommended nor supported. There are challenges with
the same origin policy, keeping the JavaScript and native portions of Cordova
synchronized at the same version [...]
<p>The display of remotely-loaded HTML content in a webview should be done
using Cordova's InAppBrowser. The InAppBrowser is designed so that
JavaScript running there does not have access to the Cordova JavaScript APIs
for the reasons listed above. Please refer to the <a
href="../appdev/security/index.html">Security Guide</a>.</p>
-<h1>Keeping Up</h1>
+<h2>Keeping Up</h2>
<p>Here are a few ways to keep up to date with Cordova.</p>
@@ -2443,18 +2453,43 @@ cordova plugin add some-plugin
<li>Subscribe to the <a href="https://cordova.apache.org/contact/";>developer
list</a>. Note - this is not a support group, but a place where development of
Cordova is discussed.</li>
</ul>
-<h1>Getting Help</h1>
+<h2>Getting Help</h2>
<p>The following links are the best places to get help for Cordova:</p>
<ul>
- <li>Slack: <a href="http://slack.cordova.io/";>http://slack.cordova.io/</a>
The official Cordova Slack channel is a great way to get help from the
community, and the place you are most likely to get answers to your
questions</li>
- <li>StackOverflow: <a
href="https://stackoverflow.com/questions/tagged/cordova";>https://stackoverflow.com/questions/tagged/cordova</a>
-By using the Cordova tag, you can view and browse all Cordova questions. Note
that StackOverflow automatically converts the "Phonegap" tag to
"Cordova", so this way you will be able to access historical
questions as well</li>
- <li>PhoneGap Google Group: <a
href="https://groups.google.com/forum/#!forum/phonegap";>https://groups.google.com/forum/#!forum/phonegap</a>
-This Google Group was the old support forum when Cordova was still called
PhoneGap. While there are still a lot of Cordova users that frequently visit
this group, the Cordova community has expressed an interest in focusing less on
this group and instead using StackOverflow for support</li>
- <li>Meetup: <a
href="https://phonegap.meetup.com";>http://phonegap.meetup.com</a> -
-Consider finding a local Cordova/PhoneGap meetup group</li>
+ <li>
+ <p><a href="https://github.com/apache/cordova/discussions";>GitHub
Discussions - Apache Cordova</a></p>
+
+ <p>The official Apache Cordova GitHub Discussions channel is a recent
addition to our support resources, aimed at centralizing community discussions
and questions within our GitHub repositories.</p>
+
+ <p>This channel is highly recommended as it brings together all things
Cordova and provides the advantage of retaining a complete history of
discussions. By utilizing GitHub Discussions, we can ensure better continuity
and accessibility for future reference.</p>
+ </li>
+ <li>
+ <p><a href="https://s.apache.org/cordova-slack";>Slack - Apache
Cordova</a></p>
+
+ <p>The official Apache Cordova Slack workspace is an excellent resource
for seeking help from the community and obtaining quick answers to your
questions.</p>
+
+ <p>However, it's important to note that our Slack workspace does not
retain message history. This limits the accessibility of information in the
long term. To ensure better retention of your question, it is advisable to
create a thread in GitHub Discussions and share the link and a summary of your
question in the Slack.</p>
+
+ <p>This way, you can benefit from the immediate responsiveness of Slack
while also preserving the discussion and making it more accessible for future
reference.</p>
+ </li>
+ <li>
+ <p><a href="StackOverflowCommunity">Stack Overflow - Apache Cordova</a></p>
+
+ <p>On Stack Overflow, the "cordova" tag can be used to browse
all Cordova questions.</p>
+
+ <p><em>Note: StackOverflow automatically converts the "phonegap"
tag to "cordova" to maintain historical questions.</em></p>
+
+ <p>Stack Overflow has a vast and diverse community, making it an excellent
choice for obtaining results depending on the nature of your question. For
instance, even if you are developing a Cordova App, if your question pertains
more to web or native app development, utilizing this platform could be more
suitable. By doing so, you expose your question to a broader community that
specializes in those specific fields.</p>
+ </li>
+ <li>
+ <p><a href="https://groups.google.com/forum/#!forum/phonegap";>Google Group
- PhoneGap</a></p>
+
+ <p>This Google Group was previously the support forum for Cordova when it
was known as PhoneGap. Although this group is currently inactive, it remains
accessible for historical reference.</p>
+
+ <p>It is advisable to utilize alternative platforms such as <a
href="https://github.com/apache/cordova/discussions";>GitHub Discussions</a>, <a
href="https://stackoverflow.com/questions/tagged/cordova";>Stack Overflow</a>,
or <a href="https://s.apache.org/cordova-slack";>Slack</a> for obtaining support
and engaging with the Cordova community. These platforms provide more active
for assistance and discussions.</p>
+ </li>
</ul>
diff --git a/feed.xml b/feed.xml
index cc4ce59bed..32d49084a5 100644
--- a/feed.xml
+++ b/feed.xml
@@ -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>Fri, 26 May 2023 11:20:53 +0000</pubDate>
- <lastBuildDate>Fri, 26 May 2023 11:20:53 +0000</lastBuildDate>
+ <pubDate>Fri, 26 May 2023 12:38:24 +0000</pubDate>
+ <lastBuildDate>Fri, 26 May 2023 12:38:24 +0000</lastBuildDate>
<generator>Jekyll v4.3.2</generator>
<item>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
