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 dec3ac3 Update Components.md
dec3ac3 is described below
commit dec3ac33733a47eab1dd5f4d109f79882036ffc0
Author: Andrew Wetmore <[email protected]>
AuthorDate: Sun May 19 10:59:24 2019 -0300
Update Components.md
Added details about components in general, and component sets in particular.
---
User-interface/Components.md | 47 +++++++++++++++++++++++++++++++++-----------
1 file changed, 36 insertions(+), 11 deletions(-)
diff --git a/User-interface/Components.md b/User-interface/Components.md
index d042864..ffacc19 100644
--- a/User-interface/Components.md
+++ b/User-interface/Components.md
@@ -19,25 +19,50 @@ title: Components
---
# Components
-*This page will discuss the various component sets available and point to
where to learn about using specific components.*
+Royale provides a wide range of components to help you design a user interface
that presents your material clearly and offers a pleasing user experience. As
with Flex, these include:
+
+ * Layout aids (groups, cards, grids, forms)
+ * Ways to display data (lists, text boxes, tables, charts, repeating
components)
+ * Navigation aids (tab bars, drop-down menus, wizards, view states)
+ * User-input controls (text entry fields, buttons, checkboxes, sliders)
+ * Usability features (alerts, snackbar pop-ups, localization features,
dynamic displays depending on the user's metadata)
+ * Rich content (images, videos, audio, transitions)
+
+Developers who have worked in Flex will quickly feel at home with Royale
components, although they will need to pay attention to the ["Pay as you
go"](Welcome/Features/PAYG.html) concept that is a Royale hallmark. Components
do well the basic functions associated with their names, but to add features
(for instance, you want to force the text the user enters to lower case), you
need to add the appropriate bead to the strand of the component:
+
+```
+<j:TextInput text="Your entry will appear in LOWER case">
+ <js:beads>
+ <j:LowerCase/>
+ </js:beads>
+</j:TextInput>
+```
+
+You can [read more about Strands and Beads
here](Welcome/Features/Strands_and_Beads.html).
## Component sets
-*General information about component sets.*
+Royale has a series of component sets, groups of ready-to-use components which
are designed for different purposes.
+
+### Basic component set
+The Basic set complies strictly with the PAYG guidelines and generates the
smallest amount of code so it compiles quickly.
### Express component set
The Express set is designed for rapid prototyping and proofs-of-concepts and
is not optimized for size and performance. Applications built with the Express
components can still be deployed in production environments if the size and
performance is acceptable, which it often is.
-### Basic component set
-*Details coming soon.*
+### Jewel component set
+Jewel is a little less compliant with PAYG so it can provide a great
off-the-shelf look and feel.
+
+<a href="https://royale.apache.org/tourdejewel/"; target="_blank">Tour de
Jewel</a> provides working examples of Royale components styled in Jewel, with
source code you can copy and paste into your own project.
### MDL component set
-*Details coming soon.*
+The MateriaDesignLite set wraps the display concepts related to <a
href="https://en.wikipedia.org/wiki/Material_Design"; target="_blank">Google's
Material Design</a> language.
-### HTML component set
-*Details coming soon.*
+### MXRoyale/MXSpark component set
+This component set seeks to emulate the functions and experience Flex
developers are familiar with.
-### Flat component set
-*Details coming soon.*
+### Other component sets
+There are several other component sets that are proofs-of-concept that wrap
existing JavaScript frameworks. They include:
-### Vivid component set
-*Details coming soon.*
+ * CreateJS
+ * Flat
+ * JQuery
