DocumentationAEMCore Components Guide

Form Hidden Component

Last update: Fri Jun 24 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin
  • User

The Core Component Form Hidden component allows for the display of a hidden field.

Usage

The Core Component Form Hidden Component allows for the creation of hidden fields to pass information about the current page back to AEM and is intended to be used along with the form container component.

The field properties can be defined by the content editor in the configure dialog.

Version and Compatibility

The current version of the Form Hidden Component is v2, which was introduced with release 2.0.0 of the Core Components in January 2018, and is described in this document.

The following table details all supported versions of the component, the AEM versions with which the versions of the component is compatible, and links to documentation for previous versions.

Component Version
AEM 6.4
AEM 6.5
AEM as a Cloud Service
v2
Compatible with
release 2.17.4 and prior
Compatible
Compatible
v1
Compatible
Compatible
Compatible

For more information about Core Component versions and releases, see the document Core Components Versions.

Sample Component Output

To experience the Form Hidden Component as well as see examples of its configuration options as well as HTML and JSON output, visit the Component Library.

Technical Details

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

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

Configure Dialog

The configure dialog allows the content author to define the parameters of the hidden field.

Form hidden edit dialog

  • Name - The name of the field, which is submitted with the form data

  • Value - The value of the field, which is submitted with the form data

  • ID - This option allows to control the unique identifier of the component in the HTML and in the Data Layer.

    • If left blank, a unique ID is automatically generated for you and can be found by inspecting the resulting page.
    • If an ID is specified, it is the responsibility of the author to make sure that it is unique.
    • Changing the ID can have an impact on CSS, JS and Data Layer tracking.

Because the Form Hidden component normally has no visible attributes, the component’s placeholder in the editor displays the Name and Value field values if they are assigned in order to help the author identify the appropriate Form Hidden component.

Example of Form Hidden Component

Design Dialog

Styles Tab

The Form Hidden Component supports the AEM Style System.

d2be9096-a81e-404b-9952-d8925af7219c