Componente Texto de formulario (versión 1) form-text-component-v

El componente principal Texto de formulario permite introducir el texto del formulario para enviarlo.

Uso usage

El componente Texto de formulario permite enviar diferentes tipos de texto y está diseñado para utilizarse junto con el componente Contenedor de formulario.

El editor de contenido puede definir el tipo de validación de texto, etiquetas y mensajes de ayuda en el cuadro de diálogo de configuación.

Versión y compatibilidad version-and-compatibility

Este documento describe la versión 1 del componente Texto de formulario, introducido originalmente con la versión 1.0.0 de los componentes principales con AEM 6.3.

En la tabla siguiente se muestra la compatibilidad de la versión 1 del componente Texto de formulario.

Versión de AEM
Componente Texto de formulario (versión 1)
6.3
Compatible
6.4
Compatible
CAUTION
Este documento describe la versión 1 del componente Texto de formulario.
Para obtener más información sobre la versión actual del componente Texto de formulario, consulte el documento Componente Texto de formulario.

Salida del componente de ejemplo sample-component-output

El siguiente es un ejemplo tomado de We.Retail.

Captura de pantalla 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">
   </div>
  </div>
 </form>
</div>

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": [
                "text"
              ],
              ":type": "weretail/components/form/container"
            }
NOTE
La exportación de JSON desde los componentes principales requiere la versión 1.1.0 de los componentes principales. Consulte la información de compatibilidad para los componentes principales (versión 1) para obtener más información.

Cuadro de diálogo de configuración configure-dialog

El cuadro de diálogo de configuración permite al autor del contenido definir el tipo de texto que se va a introducir, así como los valores predeterminados y las etiquetas.

Principal main

  • Restricción: tipo de texto que se va a introducir y que servirá para validar

    • Texto
    • Área de texto
    • Correo electrónico
    • Tel
    • Fecha
    • Número
    • Contraseña
  • Líneas de texto: número de líneas que se mostrarán en el área de texto (solo se muestran cuando Restricción se establezca en Área de texto)

  • Etiqueta: la etiqueta que se mostrará para el campo.

  • Ocultar la etiqueta para que no se muestre: necesario si la etiqueta es necesaria solo para fines de accesibilidad y no proporciona información visual adicional sobre el campo

  • Nombre elemento: el nombre del campo, que se envía con los datos del formulario

  • Valor: valor predeterminado que se rellena previamente en el campo

Acerca de about

  • Mensaje de ayuda: una sugerencia al usuario sobre lo que se puede introducir en el campo
  • Mostrar el mensaje de ayuda como marcador de posición: si desea mostrar el mensaje de ayuda dentro de la entrada del formulario cuando está vacía y no seleccionada

Restricciones constraints

  • Mensaje de restricción

    • El mensaje se muestra como información cuando se envía el formulario si el valor no valida el tipo elegido
    • No se muestra para los tipos de restricción Texto y Área de texto
  • Obligatorio: si se selecciona, el usuario debe rellenar un valor antes de enviar el formulario

  • Hacer de solo lectura: si está seleccionado, el usuario no puede modificar el valor del campo

Cuadro de diálogo de diseño design-dialog

No hay ningún cuadro de diálogo de diseño para el componente Texto de formulario.

Detalles técnicos technical-details

La documentación técnica más reciente sobre el componente Texto de formulario se encuentra en GitHub.

Todo el proyecto de componentes principales se puede descargar desde GitHub.

Puede encontrar más información sobre el desarrollo de componentes principales en la documentación para desarrolladores de componentes principales.

recommendation-more-help
d2be9096-a81e-404b-9952-d8925af7219c