You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2020/08/20 17:56:51 UTC
[royale-asjs] branch develop updated: jewel-card: docs updated
This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new 69fe2ab jewel-card: docs updated
69fe2ab is described below
commit 69fe2abe5b95ae47f8fc37edcaae2315a3a55a2a
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Thu Aug 20 19:56:32 2020 +0200
jewel-card: docs updated
---
.../Jewel/src/main/royale/org/apache/royale/jewel/Card.as | 6 ++++--
.../org/apache/royale/jewel/supportClasses/card/CardActions.as | 3 +++
.../royale/jewel/supportClasses/card/CardExpandedContent.as | 4 +++-
.../org/apache/royale/jewel/supportClasses/card/CardHeader.as | 9 +++++----
.../royale/jewel/supportClasses/card/CardPrimaryContent.as | 6 ++++--
.../org/apache/royale/jewel/supportClasses/card/CardTitle.as | 6 ++++--
6 files changed, 23 insertions(+), 11 deletions(-)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Card.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Card.as
index da0d4df..6a5b318 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Card.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Card.as
@@ -19,9 +19,11 @@
package org.apache.royale.jewel
{
/**
- * The Card class is a container that surronds other components.
+ * The Card class is a container for content like text or images that support
+ * optional parts like title and actions (usually buttons).
+ *
* Card has a default "panel" style and can compose other containers like
- * CardHeader, CardPrimaryContent and CardActions
+ * CardHeader, CardPrimaryContent, CardExpandedContent and CardActions
*
* @langversion 3.0
* @playerversion Flash 10.2
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardActions.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardActions.as
index 7410744..b66c454 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardActions.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardActions.as
@@ -23,6 +23,9 @@ package org.apache.royale.jewel.supportClasses.card
/**
* The CardActions class is a footer for Cards where actions (i.e: buttons, icons)
* use to be located.
+ *
+ * Actions are placed horizontally by default, and can be separated using
+ * BarSection for left, middle and right sections.
*
* @langversion 3.0
* @playerversion Flash 10.2
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardExpandedContent.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardExpandedContent.as
index 470e503..010bc6e 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardExpandedContent.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardExpandedContent.as
@@ -24,9 +24,11 @@ package org.apache.royale.jewel.supportClasses.card
* The CardExpandedContent class is a container that expand inner content
* removing paddings. This could be convinient for content that needs to
* avoid gaps with the surronding container.
- *
+ *
* For example a Jewel TabBar or Navigation that needs to fill
* all the available space.
+ *
+ * Content are placed vertically by default.
*
* @langversion 3.0
* @playerversion Flash 10.2
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardHeader.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardHeader.as
index e14e640..f526ad9 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardHeader.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardHeader.as
@@ -21,8 +21,11 @@ package org.apache.royale.jewel.supportClasses.card
import org.apache.royale.jewel.HContainer;
/**
- * The CardHeader class is a header for Cards where Title and actions (i.e: buttons, icons)
- * can be located.
+ * The CardHeader class is a header used in Jewel Card component where title, icons
+ * or actions (i.e: buttons, icons) can be located.
+ *
+ * Actions are placed horizontally by default, and can be separated using
+ * BarSection for left, middle and right sections.
*
* @langversion 3.0
* @playerversion Flash 10.2
@@ -45,7 +48,5 @@ package org.apache.royale.jewel.supportClasses.card
typeNames = "card-header";
}
-
-
}
}
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardPrimaryContent.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardPrimaryContent.as
index 9e5c86f..074fd1c 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardPrimaryContent.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardPrimaryContent.as
@@ -22,8 +22,10 @@ package org.apache.royale.jewel.supportClasses.card
import org.apache.royale.jewel.VContainer;
/**
- * The CardPrimaryContent class is a the main container for Cards.
- * Adding this container means we want a more complex card structure
+ * The CardPrimaryContent class is a the main content container for Cards.
+ * Adding this container means we want a more complex card structure.
+ *
+ * Content are placed vertically by default.
*
* @langversion 3.0
* @playerversion Flash 10.2
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardTitle.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardTitle.as
index 4e418b7..8ddfa79 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardTitle.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/card/CardTitle.as
@@ -21,8 +21,10 @@ package org.apache.royale.jewel.supportClasses.card
import org.apache.royale.jewel.Label;
/**
- * The CardTitle class is a header for Cards where Title and actions (i.e: buttons, icons)
- * can be located.
+ * The CardTitle class is a header title for Cards that can be used inside CardHeader
+ * or direclty inside Card.
+ *
+ * It adds some styling to labels used as titles for Cards.
*
* @langversion 3.0
* @playerversion Flash 10.2