Form Text Component (v1) form-text-component-v

The Core Component Form Text component allows the entry of form text for submission.

Usage usage

The Form Text Component allows for the submission of different types of text and is intended to be used along with the form container component.

The type of text validation, labels, and help messages can be defined by the content editor in the configure dialog.

Version and Compatibility version-and-compatibility

This document describes v1 of the Form Text Component, originally introduced with release 1.0.0 of the Core Components with AEM 6.3.

The following table lists the compatibility of v1 of the Form Text Component.

AEM Version
Form Text Component v1
This document describes v1 of the Form Text Component.
For details of the current version of the Form Text Component, see the Form Text Component document.

Sample Component Output sample-component-output

The following is sample taken from We.Retail.

Screenshot screenshot

HTML html

<div class="cmp cmp-form aem-GridColumn aem-GridColumn--default--12">
 <form method="POST" action="/content/we-retail/us/en/experience.html" id="new_form" name="new_form" enctype="multipart/form-data" class="aem-Grid aem-Grid--12 aem-Grid--default--12 ">
     <input type="hidden" name=":formstart" value="/content/we-retail/us/en/experience/jcr:content/root/responsivegrid/container">
     <div class="cmp cmp-form-field aem-GridColumn aem-GridColumn--default--12">
   <div class="form-group">
       <label for="form-text-978484744">How many pieces of toast would you like?</label>
          <input type="number" id="form-text-978484744" name="pieces">

JSON json

"container": {
              "columnClassNames": "aem-GridColumn aem-GridColumn--default--12",
              "columnCount": 12,
              "gridClassNames": "aem-Grid aem-Grid--12 aem-Grid--default--12",
              ":items": {
                "text": {
                  "columnClassNames": "aem-GridColumn aem-GridColumn--default--12",
                  ":type": "weretail/components/form/text",
                  "name": "piecesOfToast",
                  "jcr:title": "How many pieces of toast would you like?",
                  "type": "number",
                  "rows": "2"
              ":itemsOrder": [
              ":type": "weretail/components/form/container"
JSON export from the Core Components requires release 1.1.0 of the Core Components. Please see the compatibility information for Core Components v1 for more information.

Configure Dialog configure-dialog

The configure dialog allows the content author to define the type of text to be input as well as default values and labels.

Main main

  • Constraint - The type of text to be input and will be validated against

    • Text
    • Text Area
    • Email
    • Tel
    • Date
    • Number
    • Password
  • Text lines - Number of lines to be displayed in the text area (only displayed when Constraint is set to Text Area)

  • Label - The label that will be displayed for the field

  • Hide the label from being displayed - Needed if the label is required only for accessibility purposes and does not impart any additional visual information about the field

  • Element Name - The name of the field that is submitted with the form data

  • Value - Default value that is pre-populated in the field

About about

  • Help Message - A hint to the user of what can be entered in the field
  • Display help message as placeholder - To display the help message inside the form input when it is empty and not focused

Constraints constraints

  • Constraint Message

    • Message displayed as tooltip when submitting the form if the value does not validate the Type chosen
    • Not displayed for Text and Text Area constraint types
  • Required - If selected the user must fill in a value before submitting the form

  • Make read only - If selected the user cannot modify the value of the field

Design Dialog design-dialog

There is no design dialog for the Form Text component.

Technical Details technical-details

The latest technical documentation about the Form Text Component can be found on GitHub.

The entire core components project can be downloaded from GitHub.

Further details about developing Core Components can be found in the Core Components developer documentation.