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 2019/09/02 17:26:42 UTC
[royale-docs] branch master updated: component-sets pages now uses
permalinks
This is an automated email from the ASF dual-hosted git repository.
carlosrovira 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 f5a784f component-sets pages now uses permalinks
f5a784f is described below
commit f5a784feec5441e8c7dbc498cb18a7b3fdb254f1
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Mon Sep 2 19:26:35 2019 +0200
component-sets pages now uses permalinks
---
component-sets.md | 6 ++-
component-sets/basic.md | 12 ++----
component-sets/basic/basic-button.md | 5 ++-
component-sets/jewel.md | 58 ++++++++++++++--------------
component-sets/jewel/jewel-alert.md | 1 +
component-sets/jewel/jewel-button.md | 4 +-
component-sets/jewel/jewel-card.md | 3 +-
component-sets/jewel/jewel-checkbox.md | 4 +-
component-sets/jewel/jewel-combobox.md | 2 +
component-sets/jewel/jewel-datechooser.md | 2 +
component-sets/jewel/jewel-datefield.md | 2 +
component-sets/jewel/jewel-dropdownlist.md | 2 +
component-sets/jewel/jewel-form.md | 2 +
component-sets/jewel/jewel-formitem.md | 2 +
component-sets/jewel/jewel-grid.md | 2 +
component-sets/jewel/jewel-icon.md | 2 +
component-sets/jewel/jewel-image.md | 2 +
component-sets/jewel/jewel-label.md | 2 +
component-sets/jewel/jewel-list.md | 2 +
component-sets/jewel/jewel-numericstepper.md | 2 +
component-sets/jewel/jewel-popup.md | 2 +
component-sets/jewel/jewel-radiobutton.md | 4 +-
component-sets/jewel/jewel-simpletable.md | 2 +
component-sets/jewel/jewel-slider.md | 2 +
component-sets/jewel/jewel-snackbar.md | 2 +
component-sets/jewel/jewel-tabbar.md | 2 +
component-sets/jewel/jewel-tabbarcontent.md | 2 +
component-sets/jewel/jewel-table.md | 2 +
component-sets/jewel/jewel-textinput.md | 12 ++++--
component-sets/jewel/jewel-theme-creation.md | 8 ++--
component-sets/jewel/jewel-themes.md | 4 +-
component-sets/jewel/jewel-wizard.md | 2 +
features/externs.md | 2 +-
features/modules.md | 2 +-
features/payg.md | 2 +-
features/strands-and-beads.md | 8 ++--
get-started/frameworks.md | 6 +--
user-interface/components.md | 16 ++++++--
38 files changed, 127 insertions(+), 70 deletions(-)
diff --git a/component-sets.md b/component-sets.md
index 4117fcd..94c16f4 100644
--- a/component-sets.md
+++ b/component-sets.md
@@ -16,6 +16,8 @@
layout: docpage
title: Component Sets
+description: Sets of components and containers designed in Apache Royale.
+permalink: /component-sets
---
# Component Sets
@@ -24,7 +26,7 @@ Sets of components and containers designed in Apache Royale.
Royale provides its own component sets that support developing simple, small and fast applications for prototyping and as the basis of complete application user interfaces:
-- [Basic](component-sets/basic.html) is the most smallest, fastest and PAYG set of components possible in Royale, and is used by other sets like Jewel as its base.
+- [Basic](component-sets/basic) is the most smallest, fastest and PAYG set of components possible in Royale, and is used by other sets like Jewel as its base.
-- [Jewel](component-sets/jewel.html) is focused in look and feel and new practices present in modern development like responsivness and multiplatform. Jewel support Themes and diferent kind of desktop and mobile devices.
+- [Jewel](component-sets/jewel) is focused in look and feel and new practices present in modern development like responsivness and multiplatform. Jewel support Themes and diferent kind of desktop and mobile devices.
diff --git a/component-sets/basic.md b/component-sets/basic.md
index c922401..0c2239b 100644
--- a/component-sets/basic.md
+++ b/component-sets/basic.md
@@ -16,19 +16,13 @@
layout: docpage
title: Basic
+description: The most smallest, fastest and PAYG set
+permalink: /component-sets/basic
---
# Basic
The most smallest, fastest and PAYG set
-Basic is ...
+*information coming soon.*
-## Components
-
-| Type | Name | Description | Available SDK | State |
-|------------ |---------------- |------------------------------------------------------------------------------------------------------ |--------------- |---------- |
-| Container | | | | |
-| Components | Alert | Displays a message and one or more buttons in a view that pops up over all other controls and views. | 0.0 | Finished |
-| | Button | | | |
-| | CheckBox | | | |
\ No newline at end of file
diff --git a/component-sets/basic/basic-button.md b/component-sets/basic/basic-button.md
index d183d5b..dff764c 100644
--- a/component-sets/basic/basic-button.md
+++ b/component-sets/basic/basic-button.md
@@ -16,10 +16,11 @@
layout: docpage
title: Basic Button
+description: The Basic Button is a commonly-used rectangular button. Users can click or tap it to take an action.
+permalink: /component-sets/basic/button
---
# Basic Button
-subtitle
-text
\ No newline at end of file
+*information coming soon.*
\ No newline at end of file
diff --git a/component-sets/jewel.md b/component-sets/jewel.md
index 9e42f7b..cfb8b0c 100644
--- a/component-sets/jewel.md
+++ b/component-sets/jewel.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel
+description: A set of modern UI components
+permalink: /component-sets/jewel
---
# Jewel
@@ -24,7 +26,7 @@ A set of modern UI components
Jewel is a themeable and responsive set of user interface components for Apache Royale to help you quickly build the front end of your applications with [ActionScript](features/as3) & [MXML](features/mxml).
-It's based by design on [Basic](component-sets/basic.html) components. But while Basic is very strict with concepts like [PAYG](features/payg), in Jewel, while PAYG is important, when necessary we prioritize other things like responsiveness, themes and look and feel.
+It's based by design on [Basic](component-sets/basic) components. But while Basic is very strict with concepts like [PAYG](features/payg), in Jewel, while PAYG is important, when necessary we prioritize other things like responsiveness, themes and look and feel.
## Browser Support
@@ -54,33 +56,33 @@ For the browsers, Apache Royale generates [ECMAScript version 5 (ES5)](https://e
| Type | Name | Description | Available SDK | State |
|------------------ |------------------------------------------------------------------ |------------------------------------------------------------------------------------------------------ |--------------- |-------------- |
-| __Containers__ | [Card](component-sets/jewel/jewel-card.html) | Container that surrounds other components | | |
-| | [Grid](component-sets/jewel/jewel-grid.html) | Container that uses Grid Layout and needs other immediate children to work as cells and host content. | | |
-| | [SimpleTable](component-sets/jewel/jewel-simpletable.html) | A basic HTML table that can be declared in MXML | | Complete |
-| | [Table](component-sets/jewel/jewel-table.html) | A complex HTML table element filled from a data source. Cells are ItemRenderers. | | In Progress |
-| | [TabBarContent](component-sets/jewel/jewel-tabbarcontent.html) | A container to use with TabBar and capable of presenting organized content | | |
-| | [Wizard](component-sets/jewel/jewel-wizard.html) | 11.0+ | | |
-| __Components__ | [Alert](component-sets/jewel/jewel-alert.html) | Displays a message and one or more buttons in a view that pops up over all other controls and views. | 0.9.4 | Complete |
-| | [Button](component-sets/jewel/jewel-button.html) | A commonly-used rectangular button with a text label. Users can click or tap it to take an action. | 0.9.4 | Complete |
-| | [CheckBox](component-sets/jewel/jewel-checkbox.html) | Consists of a box that can contain a check mark and an optional label. | 0.9.4 | Complete |
-| | [ComboBox](component-sets/jewel/jewel-combobox.html) | | | |
-| | [DateChooser](component-sets/jewel/jewel-datechooser.html) | | | |
-| | [DateField](component-sets/jewel/jewel-datefield.html) | | | |
-| | [DropDownList](component-sets/jewel/jewel-dropdownlist.html) | | | |
-| | [Form](component-sets/jewel/jewel-form.html) | | | |
-| | [FormItem](component-sets/jewel/jewel-formitem.html) | | | |
-| | [Icon](component-sets/jewel/jewel-icon.html) | | | |
-| | [Image](component-sets/jewel/jewel-image.html) | | | |
-| | [Label](component-sets/jewel/jewel-label.html) | | | |
-| | [List](component-sets/jewel/jewel-list.html) | | | |
-| | [NumericStepper](component-sets/jewel/jewel-numericstepper.html) | | | |
-| | [PopUp](component-sets/jewel/jewel-popup.html) | | | |
-| | [RadioButton](component-sets/jewel/jewel-radiobutton.html) | Lets the user make a single choice within a set of mutually exclusive choices | 0.9.4 | Complete |
-| | [Slider](component-sets/jewel/jewel-slider.html) | | | |
-| | [SnackBar](component-sets/jewel/jewel-snackbar.html) | | | |
-| | [TabBar](component-sets/jewel/jewel-tabbar.html) | | | |
-| | [TextInput](component-sets/jewel/jewel-textinput.html) | A control for single-line text field. | 0.9.4 | Complete |
+| __Containers__ | [Card](component-sets/jewel/card) | Container that surrounds other components | | |
+| | [Grid](component-sets/jewel/grid) | Container that uses Grid Layout and needs other immediate children to work as cells and host content. | | |
+| | [SimpleTable](component-sets/jewel/simpletable) | A basic HTML table that can be declared in MXML | | Complete |
+| | [Table](component-sets/jewel/table) | A complex HTML table element filled from a data source. Cells are ItemRenderers. | | In Progress |
+| | [TabBarContent](component-sets/jewel/tabbarcontent) | A container to use with TabBar and capable of presenting organized content | | |
+| | [Wizard](component-sets/jewel/wizard) | 11.0+ | | |
+| __Components__ | [Alert](component-sets/jewel/alert) | Displays a message and one or more buttons in a view that pops up over all other controls and views. | 0.9.4 | Complete |
+| | [Button](component-sets/jewel/button) | A commonly-used rectangular button with a text label. Users can click or tap it to take an action. | 0.9.4 | Complete |
+| | [CheckBox](component-sets/jewel/checkbox) | Consists of a box that can contain a check mark and an optional label. | 0.9.4 | Complete |
+| | [ComboBox](component-sets/jewel/combobox) | | | |
+| | [DateChooser](component-sets/jewel/datechooser) | | | |
+| | [DateField](component-sets/jewel/datefield) | | | |
+| | [DropDownList](component-sets/jewel/dropdownlist) | | | |
+| | [Form](component-sets/jewel/form) | | | |
+| | [FormItem](component-sets/jewel/formitem) | | | |
+| | [Icon](component-sets/jewel/icon) | | | |
+| | [Image](component-sets/jewel/image) | | | |
+| | [Label](component-sets/jewel/label) | | | |
+| | [List](component-sets/jewel/list) | | | |
+| | [NumericStepper](component-sets/jewel/numericstepper) | | | |
+| | [PopUp](component-sets/jewel/popup) | | | |
+| | [RadioButton](component-sets/jewel/radiobutton) | Lets the user make a single choice within a set of mutually exclusive choices | 0.9.4 | Complete |
+| | [Slider](component-sets/jewel/slider) | | | |
+| | [SnackBar](component-sets/jewel/snackbar) | | | |
+| | [TabBar](component-sets/jewel/tabbar) | | | |
+| | [TextInput](component-sets/jewel/textinput) | A control for single-line text field. | 0.9.4 | Complete |
## Jewel Themes
-[Jewel Themes](component-sets/jewel/jewel-themes.html)
\ No newline at end of file
+[Jewel Themes](component-sets/jewel/themes)
\ No newline at end of file
diff --git a/component-sets/jewel/jewel-alert.md b/component-sets/jewel/jewel-alert.md
index 46f19d7..e73e35c 100644
--- a/component-sets/jewel/jewel-alert.md
+++ b/component-sets/jewel/jewel-alert.md
@@ -17,6 +17,7 @@
layout: docpage
title: Jewel Alert
description: The Jewel Alert component displays a message and one or more buttons in a window that pops up over all other controls and views.
+permalink: /component-sets/jewel/alert
---
# Jewel Alert
diff --git a/component-sets/jewel/jewel-button.md b/component-sets/jewel/jewel-button.md
index f56fbe6..95ab136 100644
--- a/component-sets/jewel/jewel-button.md
+++ b/component-sets/jewel/jewel-button.md
@@ -17,7 +17,7 @@
layout: docpage
title: Jewel Button
description: The Jewel Button is a commonly-used rectangular button with a text label. Users can click or tap it to take an action.
-
+permalink: /component-sets/jewel/button
---
# Jewel Button
@@ -37,7 +37,7 @@ Available since version __0.9.4__.
The Jewel Button is a commonly-used rectangular button with a text label. Users can click or tap it to take an action or make a choice.
-The Jewel Button can show different looks and feels. By default it appears with light or dark highlights depending on the [Jewel theme configuration](component-sets/jewel/jewel-theme-creation.html#theme-sass-file). You can use the `emphasis` property to tint the button with __PRIMARY__, __SECONDARY__ or __EMPHASIZED__ colors (defined as well in the Jewel theme).
+The Jewel Button can show different looks and feels. By default it appears with light or dark highlights depending on the [Jewel theme configuration](component-sets/jewel/theme-creation#theme-sass-file). You can use the `emphasis` property to tint the button with __PRIMARY__, __SECONDARY__ or __EMPHASIZED__ colors (defined as well in the Jewel theme).
When a user interacts with the button (mouse over, long-press, double-click...) the button calls an event listener to perform an action. When a user clicks the mouse on the button or taps the button on a touch screen, the button dispatches a click event.
diff --git a/component-sets/jewel/jewel-card.md b/component-sets/jewel/jewel-card.md
index 85cd820..231f86e 100644
--- a/component-sets/jewel/jewel-card.md
+++ b/component-sets/jewel/jewel-card.md
@@ -16,10 +16,9 @@
layout: docpage
title: Jewel Card
+permalink: /component-sets/jewel/card
---
# Jewel Card
-subtitle
-text
\ No newline at end of file
diff --git a/component-sets/jewel/jewel-checkbox.md b/component-sets/jewel/jewel-checkbox.md
index a633a14..6f3fd62 100644
--- a/component-sets/jewel/jewel-checkbox.md
+++ b/component-sets/jewel/jewel-checkbox.md
@@ -17,7 +17,7 @@
layout: docpage
title: Jewel CheckBox
description: The Jewel CheckBox consists of a selectable box, that can contain a check mark or not, and an optional label.
-
+permalink: /component-sets/jewel/checkbox
---
# Jewel CheckBox
@@ -133,4 +133,4 @@ On the other hand, you can add to it other common Jewel control beads to provide
Other related Jewel components are:
-* [RadioButton](component-sets/jewel/jewel-radiobutton.html)
+* [RadioButton](component-sets/jewel/radiobutton)
diff --git a/component-sets/jewel/jewel-combobox.md b/component-sets/jewel/jewel-combobox.md
index 3c3e58e..a2abdea 100644
--- a/component-sets/jewel/jewel-combobox.md
+++ b/component-sets/jewel/jewel-combobox.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel ComboBox
+description: The Jewel ComboBox
+permalink: /component-sets/jewel/combobox
---
# Jewel ComboBox
diff --git a/component-sets/jewel/jewel-datechooser.md b/component-sets/jewel/jewel-datechooser.md
index bf32e07..108ca93 100644
--- a/component-sets/jewel/jewel-datechooser.md
+++ b/component-sets/jewel/jewel-datechooser.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel DateChooser
+description: The Jewel DateChooser
+permalink: /component-sets/jewel/datechooser
---
# Jewel DateChooser
diff --git a/component-sets/jewel/jewel-datefield.md b/component-sets/jewel/jewel-datefield.md
index 95c3646..54a0409 100644
--- a/component-sets/jewel/jewel-datefield.md
+++ b/component-sets/jewel/jewel-datefield.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel DateField
+description: The Jewel DateField
+permalink: /component-sets/jewel/datefield
---
# Jewel DateField
diff --git a/component-sets/jewel/jewel-dropdownlist.md b/component-sets/jewel/jewel-dropdownlist.md
index 5bc8d1d..44086f6 100644
--- a/component-sets/jewel/jewel-dropdownlist.md
+++ b/component-sets/jewel/jewel-dropdownlist.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel DropDownList
+description: The Jewel DropDownList
+permalink: /component-sets/jewel/dropdownlist
---
# Jewel DropDownList
diff --git a/component-sets/jewel/jewel-form.md b/component-sets/jewel/jewel-form.md
index 2cdbfcd..59f76be 100644
--- a/component-sets/jewel/jewel-form.md
+++ b/component-sets/jewel/jewel-form.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Form
+description: The Jewel Form
+permalink: /component-sets/jewel/form
---
# Jewel Form
diff --git a/component-sets/jewel/jewel-formitem.md b/component-sets/jewel/jewel-formitem.md
index 34d9ed5..ba34f04 100644
--- a/component-sets/jewel/jewel-formitem.md
+++ b/component-sets/jewel/jewel-formitem.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel FormItem
+description: The Jewel FormItem
+permalink: /component-sets/jewel/formitem
---
# Jewel FormItem
diff --git a/component-sets/jewel/jewel-grid.md b/component-sets/jewel/jewel-grid.md
index 1351dd8..dd697f2 100644
--- a/component-sets/jewel/jewel-grid.md
+++ b/component-sets/jewel/jewel-grid.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Grid
+description: The Jewel Grid
+permalink: /component-sets/jewel/grid
---
# Jewel Grid
diff --git a/component-sets/jewel/jewel-icon.md b/component-sets/jewel/jewel-icon.md
index d7253ef..6fdf385 100644
--- a/component-sets/jewel/jewel-icon.md
+++ b/component-sets/jewel/jewel-icon.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Icon
+description: The Jewel Icon
+permalink: /component-sets/jewel/icon
---
# Jewel Icon
diff --git a/component-sets/jewel/jewel-image.md b/component-sets/jewel/jewel-image.md
index a87b663..a45588b 100644
--- a/component-sets/jewel/jewel-image.md
+++ b/component-sets/jewel/jewel-image.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Image
+description: The Jewel Image
+permalink: /component-sets/jewel/image
---
# Jewel Image
diff --git a/component-sets/jewel/jewel-label.md b/component-sets/jewel/jewel-label.md
index 6a4e9df..21b7acd 100644
--- a/component-sets/jewel/jewel-label.md
+++ b/component-sets/jewel/jewel-label.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Label
+description: The Jewel Label
+permalink: /component-sets/jewel/label
---
# Jewel Label
diff --git a/component-sets/jewel/jewel-list.md b/component-sets/jewel/jewel-list.md
index 8481219..386f0ac 100644
--- a/component-sets/jewel/jewel-list.md
+++ b/component-sets/jewel/jewel-list.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel List
+description: The Jewel List
+permalink: /component-sets/jewel/list
---
# Jewel List
diff --git a/component-sets/jewel/jewel-numericstepper.md b/component-sets/jewel/jewel-numericstepper.md
index 9abd21c..5608d88 100644
--- a/component-sets/jewel/jewel-numericstepper.md
+++ b/component-sets/jewel/jewel-numericstepper.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel NumericStepper
+description: The Jewel NumericStepper
+permalink: /component-sets/jewel/numericstepper
---
# Jewel NumericStepper
diff --git a/component-sets/jewel/jewel-popup.md b/component-sets/jewel/jewel-popup.md
index a741120..49e18e4 100644
--- a/component-sets/jewel/jewel-popup.md
+++ b/component-sets/jewel/jewel-popup.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel PopUp
+description: The Jewel PopUp
+permalink: /component-sets/jewel/popup
---
# Jewel PopUp
diff --git a/component-sets/jewel/jewel-radiobutton.md b/component-sets/jewel/jewel-radiobutton.md
index bf974f3..d2e78f0 100644
--- a/component-sets/jewel/jewel-radiobutton.md
+++ b/component-sets/jewel/jewel-radiobutton.md
@@ -17,7 +17,7 @@
layout: docpage
title: Jewel RadioButton
description: The Jewel RadioButton control lets the user choose one of a set of options.
-
+permalink: /component-sets/jewel/radiobutton
---
# Jewel RadioButton
@@ -135,4 +135,4 @@ On the other hand, you can add other common Jewel control beads to it to provide
Other related Jewel components are:
-* [CheckBox](component-sets/jewel/jewel-checkbox.html)
+* [CheckBox](component-sets/jewel/checkbox)
diff --git a/component-sets/jewel/jewel-simpletable.md b/component-sets/jewel/jewel-simpletable.md
index 8a05ca6..d63b6cd 100644
--- a/component-sets/jewel/jewel-simpletable.md
+++ b/component-sets/jewel/jewel-simpletable.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel SimpleTable
+description: The Jewel SimpleTable
+permalink: /component-sets/jewel/simpletable
---
# Jewel SimpleTable
diff --git a/component-sets/jewel/jewel-slider.md b/component-sets/jewel/jewel-slider.md
index 8901a73..1caf98c 100644
--- a/component-sets/jewel/jewel-slider.md
+++ b/component-sets/jewel/jewel-slider.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Slider
+description: The Jewel Slider
+permalink: /component-sets/jewel/slider
---
# Jewel Slider
diff --git a/component-sets/jewel/jewel-snackbar.md b/component-sets/jewel/jewel-snackbar.md
index 592076f..c60e09e 100644
--- a/component-sets/jewel/jewel-snackbar.md
+++ b/component-sets/jewel/jewel-snackbar.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel SnackBar
+description: The Jewel SnackBar
+permalink: /component-sets/jewel/snackbar
---
# Jewel SnackBar
diff --git a/component-sets/jewel/jewel-tabbar.md b/component-sets/jewel/jewel-tabbar.md
index 6032f4b..4c05c89 100644
--- a/component-sets/jewel/jewel-tabbar.md
+++ b/component-sets/jewel/jewel-tabbar.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel TabBar
+description: The Jewel TabBar
+permalink: /component-sets/jewel/tabbar
---
# Jewel TabBar
diff --git a/component-sets/jewel/jewel-tabbarcontent.md b/component-sets/jewel/jewel-tabbarcontent.md
index 84f70a1..5485a82 100644
--- a/component-sets/jewel/jewel-tabbarcontent.md
+++ b/component-sets/jewel/jewel-tabbarcontent.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel TabBarContent
+description: The Jewel TabBarContent
+permalink: /component-sets/jewel/tabbarcontent
---
# Jewel TabBarContent
diff --git a/component-sets/jewel/jewel-table.md b/component-sets/jewel/jewel-table.md
index b81e642..90ac483 100644
--- a/component-sets/jewel/jewel-table.md
+++ b/component-sets/jewel/jewel-table.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Table
+description: The Jewel Table
+permalink: /component-sets/jewel/table
---
# Jewel Table
diff --git a/component-sets/jewel/jewel-textinput.md b/component-sets/jewel/jewel-textinput.md
index 6015725..4f91945 100644
--- a/component-sets/jewel/jewel-textinput.md
+++ b/component-sets/jewel/jewel-textinput.md
@@ -17,7 +17,7 @@
layout: docpage
title: Jewel TextInput
description: The Jewel TextInput is a control for single-line text field
-
+permalink: /component-sets/jewel/textinput
---
# Jewel TextInput
@@ -37,7 +37,7 @@ Available since version __0.9.4__.
The Jewel TextInput implements the jewel control for single-line text field. It dispatches a change event when the user input text.
-> For multi line text input control see [TextArea](component-sets/jewel/jewel-textarea.html)
+> For multi line text input control see [TextArea](component-sets/jewel/textarea)
## Example of use
@@ -125,7 +125,7 @@ On the other hand, you can add to it beads specialy crafted for this control or
| [MaxNumberCharacters](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/MaxNumberCharacters){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to set the maximun number of characters the text field can hold. |
| [PasswordInput](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/PasswordInput){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to secures the text field by masking the input as it is typed. |
| [Restrict](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/Restrict){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to use a regular expresion pattern to validate input from user. |
-| [SearchFilterForList](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/SearchFilterForList){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to filter options in other [Jewel List](component-sets/jewel/jewel-list.html) component used in combo with the text input. |
+| [SearchFilterForList](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/SearchFilterForList){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to filter options in other [Jewel List](component-sets/jewel/list) component used in combo with the text input. |
| [TextPrompt](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/TextPrompt){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to place a string into the input field when there is no value associated with the text property. |
| [UpperCase](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/UpperCase){:target='_blank'} | [org.apache.royale.core.IBead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBead){:target='_blank'} | Add this bead to makes all text change to upper case. |
@@ -142,3 +142,9 @@ On the other hand, you can add to it beads specialy crafted for this control or
* [Binding the text property of a Jewel TextInput to update a text Label](https://royale.apache.org/binding-the-text-property-of-a-jewel-textinput-to-update-a-text-label/){:target='_blank'}
* [Using View States to show or hide content](https://royale.apache.org/using-view-states-to-show-or-hide-content/){:target='_blank'}
* [Dividing an Apache Royale application with modules](https://royale.apache.org/dividing-an-apache-royale-application-with-modules/){:target='_blank'}
+
+## Related controls
+
+Other related Jewel components are:
+
+* [TextArea](component-sets/jewel/textarea)
\ No newline at end of file
diff --git a/component-sets/jewel/jewel-theme-creation.md b/component-sets/jewel/jewel-theme-creation.md
index b7a8a12..2f1f163 100644
--- a/component-sets/jewel/jewel-theme-creation.md
+++ b/component-sets/jewel/jewel-theme-creation.md
@@ -16,13 +16,15 @@
layout: docpage
title: Jewel Theme Creation
+description: How to make a new theme for Jewel
+permalink: /component-sets/jewel/theme-creation
---
# Jewel Theme Creation
How to make a new theme for Jewel
-Jewel is a component set designed with change of appearance in mind. Jewel comes with a series of pre-designed themes so you can use it right away without having to create your own theme. You can learn more about the existing themes [here](component-sets/jewel/jewel-themes.html). The Jewel themes that come with Apache Royale define 12 colors, dark and light, flat / no-flat visuals. However, you may want a personalized look, and you can either adapt one of the existing themes or create on [...]
+Jewel is a component set designed with change of appearance in mind. Jewel comes with a series of pre-designed themes so you can use it right away without having to create your own theme. You can learn more about the existing themes [here](component-sets/jewel/themes). The Jewel themes that come with Apache Royale define 12 colors, dark and light, flat / no-flat visuals. However, you may want a personalized look, and you can either adapt one of the existing themes or create one from scratch.
## Theme basics
@@ -48,7 +50,7 @@ You'll never find a style rule in the Jewel library that define _colors, lines,
## Jewel Theme Library
-This library is like a __master theme__ where _colors, fonts, icons or shapes_ are defined, and is the library which generates Jewel theme variants, thanks to SASS preprocessing power. Each Jewel theme in Apache Royale uses the definitions in this library and [just changes a few variables to generate the variants](component-sets/jewel/jewel-theme-creation.html#theme-sass-file).
+This library is like a __master theme__ where _colors, fonts, icons or shapes_ are defined, and is the library which generates Jewel theme variants, thanks to SASS preprocessing power. Each Jewel theme in Apache Royale uses the definitions in this library and [just changes a few variables to generate the variants](component-sets/jewel/theme-creation#theme-sass-file).
## Primary, Secondary and Emphasized colors
@@ -85,7 +87,7 @@ __Jewel library__ has defintions that you don't normally need to change, while _
## A Jewel component example
-Let's take the [Jewel Alert](component-sets/jewel/jewel-alert.html) component as an example and look at the different files that compose this component:
+Let's take the [Jewel Alert](component-sets/jewel/alert) component as an example and look at the different files that compose this component:
In __Jewel library__ you can find:
diff --git a/component-sets/jewel/jewel-themes.md b/component-sets/jewel/jewel-themes.md
index e45ff46..61c2f0a 100644
--- a/component-sets/jewel/jewel-themes.md
+++ b/component-sets/jewel/jewel-themes.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Themes
+description: The look and feel of the jewel component set
+permalink: /component-sets/jewel/themes
---
# Jewel Themes
@@ -79,7 +81,7 @@ Jewel Themes are a CSS file in the end (`default.css`), with all needed CSS rule
## Predefined Jewel Themes
-Jewel library has a __master theme__ called JewelTheme and other 144 themes in the `themes` folder that are generated from JewelTheme. You can know more about how this is done in the [Jewel Theme Creation](component-sets/jewel/jewel-theme-creation.html) section.
+Jewel library has a __master theme__ called JewelTheme and other 144 themes in the `themes` folder that are generated from JewelTheme. You can know more about how this is done in the [Jewel Theme Creation](component-sets/jewel/theme-creation) section.
> Only to name a few examples, `themes/Jewel-Dark-NoFlat-Primary-Violet-Theme` or `themes/Jewel-Light-NoFlat-Secondary-Emerald-Theme` are examples of concrete jewel themes that are part of Apache Royale official distribution. There's 144 unique themes that are the combinations of the 12 colors, dark/light and flat/no-flat options.
diff --git a/component-sets/jewel/jewel-wizard.md b/component-sets/jewel/jewel-wizard.md
index 3b6850d..5117c1b 100644
--- a/component-sets/jewel/jewel-wizard.md
+++ b/component-sets/jewel/jewel-wizard.md
@@ -16,6 +16,8 @@
layout: docpage
title: Jewel Wizard
+description: The Jewel Wizard
+permalink: /component-sets/jewel/wizard
---
# Jewel Wizard
diff --git a/features/externs.md b/features/externs.md
index 93b87f3..33d43e5 100644
--- a/features/externs.md
+++ b/features/externs.md
@@ -24,7 +24,7 @@ permalink: /features/externs
Use external javascript libraries in ActiopnScript
-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) uses the HTML dialog element, which is not reliable across all browsers. So Jewel Alert references the _dialogPolyfill_ external library to make sure the display is as intended in whichever brows [...]
+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/alert) uses the HTML dialog element, which is not reliable across all browsers. So Jewel Alert references the _dialogPolyfill_ external library to make sure the display is as intended in whichever browser the aler [...]
[Google Closure Compiler (GCC)](https://developers.google.com/closure/compiler/){:target='_blank'} provides a mechanism called _@externs_ that Apache Royale uses to declare that a name for a class, property or function is defined in external code and so should not be renamed when application code is compiled.
diff --git a/features/modules.md b/features/modules.md
index 9adc574..42a0a39 100644
--- a/features/modules.md
+++ b/features/modules.md
@@ -42,7 +42,7 @@ A `Module` is a separate compilation of one or more source files that results in
A `Module` can contain code that doesn't have a UI, or it can be mostly UI. Modules can provide other UI screens and associated logic. There is a `ModuleLoader` component that displays the components that are children of a module. MXML files are commonly used to specify the UI components.
-There is an example for [Basic](component-sets/basic.html) UI Set [here](https://github.com/apache/royale-asjs/tree/develop/examples/royale/ModuleExample){:target='_blank'} and other for [Jewel](component-sets/jewel.html) UI Set can be found [here](https://github.com/apache/royale-asjs/tree/develop/examples/blog/BE0013_Dividing_an_Apache_Royale_application_with_modules){:target='_blank'}.
+There is an example for [Basic](component-sets/basic) UI Set [here](https://github.com/apache/royale-asjs/tree/develop/examples/royale/ModuleExample){:target='_blank'} and other for [Jewel](component-sets/jewel) UI Set can be found [here](https://github.com/apache/royale-asjs/tree/develop/examples/blog/BE0013_Dividing_an_Apache_Royale_application_with_modules){:target='_blank'}.
Proper use of modules can help maintain _"separation of concerns"_ which helps keep you from writing _"spaghetti code"_. If only the code in one module changes, only that module needs to be recompiled. And if that code isn't needed to show the first screen, then the application will start up faster if that module is loaded only when it is needed.
diff --git a/features/payg.md b/features/payg.md
index 711fc64..bc1f325 100644
--- a/features/payg.md
+++ b/features/payg.md
@@ -60,7 +60,7 @@ The ‘paying’ aspect of PAYG does not include _developer effort_ in the ‘pa
The _Express_ component set has pre-composed components that feature combinations of functionality to suit general use cases. This reduces the time and effort required to deploy common components by including their more commonly needed functionality, helping balance ease of development against __PAYG__ benefits.
-Similarly, the [Jewel](component-sets/jewel.html){:target='_blank'} component set is designed with PAYG in mind but tries to balance towards the usability of the framework and to not be PAYG-strict.
+Similarly, the [Jewel](component-sets/jewel){:target='_blank'} component set is designed with PAYG in mind but tries to balance towards the usability of the framework and to not be PAYG-strict.
## PAYG vs DRY
diff --git a/features/strands-and-beads.md b/features/strands-and-beads.md
index 62b1a84..0ac4ec3 100644
--- a/features/strands-and-beads.md
+++ b/features/strands-and-beads.md
@@ -44,8 +44,8 @@ Every Royale component contains the minimum code necessary to perform its basic
Finding the beads that will provide what you want for a given component, or even knowing what beads are available in the official Apache Royale SDK can be a daunting task. There are hundreds of these little pieces of code distributed all over the framework code. For this reason we are gradually assembling a list of beads on each component page, so users can refer to a concrete _strand_ (the component) and see a list of _beads_ that work with it. Normally you can have:
-* __Specific Component Beads__. (beads only usable for a specific component, like [Jewel PasswordInput](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/PasswordInput){:target='_blank'} for an instance of [Jewel TextInput](component-sets/jewel/jewel-textinput.html))
-* __Common Shared Beads__. Beads that can be used with more than one component, like [Jewel Disabled bead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls/Disabled){:target='_blank'}, which can be used by [Jewel Button](component-sets/jewel/jewel-button.html), [Jewel TextInput](component-sets/jewel/jewel-textinput.html) or [Jewel CheckBox](component-sets/jewel/jewel-checkbox.html).
+* __Specific Component Beads__. (beads only usable for a specific component, like [Jewel PasswordInput](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/PasswordInput){:target='_blank'} for an instance of [Jewel TextInput](component-sets/jewel/textinput))
+* __Common Shared Beads__. Beads that can be used with more than one component, like [Jewel Disabled bead](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls/Disabled){:target='_blank'}, which can be used by [Jewel Button](component-sets/jewel/button), [Jewel TextInput](component-sets/jewel/textinput) or [Jewel CheckBox](component-sets/jewel/checkbox).
## Adding a bead
@@ -55,7 +55,7 @@ There are three ways to add beads to a component: bake it into the code using `<
Each _strand_ supports a `beads` array and users can add beads in MXML.
-In the following example we are using the [Jewel TextInput](component-sets/jewel/jewel-textinput.html) strand to add [Jewel TextPrompt](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/TextPrompt){:target='_blank'} and [Jewel Disabled](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls/Disabled){:target='_blank'} beads to the strand. Note that while `TextPrompt` is specific to TextInput, you can use `Disabled` wi [...]
+In the following example we are using the [Jewel TextInput](component-sets/jewel/textinput) strand to add [Jewel TextPrompt](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls.textinput/TextPrompt){:target='_blank'} and [Jewel Disabled](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controls/Disabled){:target='_blank'} beads to the strand. Note that while `TextPrompt` is specific to TextInput, you can use `Disabled` with many Jew [...]
```mxml
<j:TextInput text="Disabled with text...">
@@ -79,7 +79,7 @@ IBeadView: ClassReference("org.apache.royale.jewel.beads.views.ListView");
```
Royale uses __CSS__ to configure components with defaults beads. The following
-code snippet is the default initial bead configuration for a [Jewel List](component-sets/jewel/jewel-list.html) and is declared though [SASS](https://sass-lang.com){:target='_blank'} (that gets compiled to __CSS__).
+code snippet is the default initial bead configuration for a [Jewel List](component-sets/jewel/list) and is declared though [SASS](https://sass-lang.com){:target='_blank'} (that gets compiled to __CSS__).
```sass
j|List
diff --git a/get-started/frameworks.md b/get-started/frameworks.md
index 0e318bd..d21fb20 100644
--- a/get-started/frameworks.md
+++ b/get-started/frameworks.md
@@ -40,11 +40,11 @@ Documentation for Crux will be available soon.
## Apache Royale Component Sets
-Apache Royale supports its own [component sets](component-sets.html) of controls, options for grouping controls, and other elements designed to help developers get the most of the technology.
+Apache Royale supports its own [component sets](component-sets) of controls, options for grouping controls, and other elements designed to help developers get the most of the technology.
-- [Basic](component-sets/basic.html) is the most smallest, fastest and most PAYG set of components possible in Royale, and is used by other sets like Jewel as their base.
+- [Basic](component-sets/basic) is the most smallest, fastest and most PAYG set of components possible in Royale, and is used by other sets like Jewel as their base.
-- [Jewel](component-sets/jewel.html) is focused in look and feel and new practices present in modern development like responsivness and multiplatform support. Jewel supports Themes and diferent kind of desktop and mobile devices.
+- [Jewel](component-sets/jewel) is focused in look and feel and new practices present in modern development like responsivness and multiplatform support. Jewel supports Themes and diferent kind of desktop and mobile devices.
Why would you use a third-party framework with Royale? Because you like the look and feel of that framework's user interface components but want to use ActionScript to handle the business logic and/or use MXML to set up the UI.
diff --git a/user-interface/components.md b/user-interface/components.md
index ac4377d..2943e4d 100644
--- a/user-interface/components.md
+++ b/user-interface/components.md
@@ -44,26 +44,33 @@ Developers who have worked in Flex will quickly feel at home with Royale compone
You can [read more about Strands and Beads here](features/strands-and-beads).
## Component sets
-Royale has a series of [component sets](component-sets.html), groups of ready-to-use components which are designed for different purposes.
+
+Royale has a series of [component sets](component-sets), groups of ready-to-use components which are designed for different purposes.
### Basic component set
-The [Basic](component-sets/basic.html) set complies strictly with the PAYG guidelines and generates the smallest amount of code so it compiles quickly.
+
+The [Basic](component-sets/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 Basic components with lots of Beads packed into them by default. It 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 are acceptable, which is often the case.
### Jewel component set
-[Jewel](component-sets/jewel.html) is a little less compliant with PAYG so it can provide a great off-the-shelf look and feel.
-[Tour de Jewel](https://royale.apache.org/tourdejewel/){:target='_blank'} provides working examples of Royale components styled in Jewel, with source code you can copy and paste into your own project.
+[Jewel](component-sets/jewel) is a little less compliant with PAYG so it can provide a great off-the-shelf look and feel.
+
+[Tour de Jewel](https://royale.apache.org/tourdejewel){:target='_blank'} provides working examples of Royale components styled in Jewel, with source code you can copy and paste into your own project.
### MDL component set
+
The MateriaDesignLite set wraps the display concepts related to [Google's Material Design](https://en.wikipedia.org/wiki/Material_Design){:target='_blank'} language. This library wraps the components of [Material Design Lite](https://getmdl.io/components/index.html){:target='_blank'} library.
### MXRoyale/MXSpark component sets
+
This component set seeks to emulate the functions and experience Flex developers are familiar with.
### Other component sets
+
There are several other component sets that are proofs-of-concept that wrap existing JavaScript frameworks. They include:
* CreateJS
@@ -71,6 +78,7 @@ There are several other component sets that are proofs-of-concept that wrap exis
* JQuery
## Component sets for your application
+
When you download the Royale SDK to your local computer, you can browse the component sets in this location:
`royale-asjsframeworks/projects`