This is an automated email from the ASF dual-hosted git repository.
andreww pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 7f5caf6 Update externs.md
7f5caf6 is described below
commit 7f5caf6b22ae5b9d95290edc84ae321435cf3067
Author: Andrew Wetmore <[email protected]>
AuthorDate: Wed Aug 21 14:33:31 2019 -0300
Update externs.md
Completed first version.
---
user-interface/externs.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/user-interface/externs.md b/user-interface/externs.md
index 61aff21..1d8d045 100644
--- a/user-interface/externs.md
+++ b/user-interface/externs.md
@@ -20,10 +20,12 @@ title: externs
# Externs
-Some Apache Royale elements, like HTML dialog, at the moment have limited
cross-browser support. To get reliable display and performance in those cases,
Royale makes use of existing external JavaScript libraries.
+Some Apache Royale elements at the moment have limited cross-browser support.
To get reliable display and performance in those cases, Royale makes use of
existing external JavaScript libraries. For example,
[Jewel.Alert](https://apache.github.io/royale-docs/component-sets/jewel/jewel-alert.html){:target='_blank'}
uses the HTML dialog element and references the _dialogPolyfill_ external
library to make sure the display is as intended in all modern browsers.
-Google Closure Compiler (GCC) provides a mechanism called @externs that is
used in Apache Royale for declaring that a name is defined in external code and
so should not be renamed.
+Google Closure Compiler (GCC) provides a mechanism called _@externs_ that
Apache Royale uses to declare that a name for a property or function is defined
in external code and so should not be renamed when application code is compiled.
The compiler assumes that externs will exist in the environment in which the
compiled JavaScript will be interpreted.
-So dialogPolyfill is an AS3 class with a line in the comments with @externs.
That informs Apache Royale that this class is an extern for GCC. So that code
already exists as a JS library and Apache Royale knows the methods a properties
so you can get those in IDEs using code intelligence :)
+Jewel.Alert invokes _dialogPolyfill_, which is an AS3 class with _@externs_ in
its comments. That informs GCC that this class has the same name as the
external JavaScript library it references, and is not to be renamed in the
compile process. Apache Royale can use the properties of the external library,
and you can even see them as options if you are using an IDE, with code
intelligence enabled.
+
+To learn more about using the huge range of external JavaScript libraries that
is available, see [Using external JavaScript libraries in Apache
Royale](https://royale.apache.org/using-external-javascript-libraries-in-apache-royale/){:target='_blank'}.
