Form - Hidden

Component Information

Component Title Form Hidden
Description The Core Component Form Hidden component allows for the display of a hidden field.
  • Allows a form owner to add hidden data to the form
Location /apps/ehi-core/aem65/components/form/hidden/v1/hidden
sling:resourceSuperType core/wcm/components/form/hidden/v2/hidden
Supported AEM Versions 6.5
Editing Mode inPlaceEdit
Component Group Cheerios Experience
Use Object The Form Hidden component uses the com.adobe.cq.wcm.core.components.models.form.Field Sling Model for its Use-object.



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 .

Extending the Components

Extending the components can be done in multiple ways depending on the needs of the brand component.


Use this approach if you do not have any required html markup changes or backend java changes. This will only update the title of the component, componentGroup and point to the resourceSuperType. Optionally can extend the description.

  1. Change .content.xml file properties 
  2. sling:resourceSuperType to point to the Cheer.IOs component [required]
  3. jcr:title - new Component title
  4. componentGroup - Brand specific Group [required]
  5. jcr:description - Helpful description



Use this approach if you need to update css classes or add data attributes and do not need to change the backend model, or potentially want to use a different model by retain all of the markup in the component-tmpl.html (Component Template) markup.

  1. Follow steps in Extend the Component - Basic
  2. Extend the file i.e. extend-example-option2.html
  3. Update file with new properties
  4. Update the html file with desired changes



The component template is usually named component-tmpl.html this file contains the html markup. Update this file if you need to change the html structure of the component.

  1. Follow Steps in Extend Component Basic
  2. Extend the file component.html to point to the new component-tmpl.html file
  3. Extend the file i.e. component-tmpl.html
  4. Update file with new markup



Use this approach if you need to change the Sling Model to update the backend logic.

Files that will need to be added when extending:

  1. Follow Steps in Extend Component - Basic
  2. Java Interface - this will implement the model with the new methods (if needed)
  3. Sling Model - this will implement the Java Interface from step 1 and leverage the sling delegation pattern to override the original methods
  4. The component.html file to match the new component name

It is possible to extend more than just the component.html file, if necessary any file that is resourceSupertyped can be extend for example if something needs added to the dialog.

This gives us the flexibility to change our classes or add attributes easily.  Say I want to add new javascript I can easily target a different data attribute to trigger my javascript.

Configuration Properties

Edit Dialog Properties

The following properties are written to JCR for this Form Hidden component and are expected to be available as Resource properties:

  1. ./name - defines the name of the field, which will be submitted with the form data
  2. ./value - defines the value of the field, which will be submitted with the form data
  3. ./id - defines the identifier of this field, which should be unique on the page

Edit Dialog Visual

Component Demo

  1. jcr:primaryType: nt:unstructured
  2. jcr:createdBy: E524Z2
  3. jcr:lastModifiedBy: E524Z2
  4. jcr:created:
  5. id: Identifier
  6. name: Name
  7. value: Value
  8. jcr:lastModified:
  9. sling:resourceType: ehi-core/aem65/components/form/hidden/v1/hidden