Form - Button

Component Information

Component Title Form Button
Description The  Form Button Component allows for the inclusion of a button to trigger an action on a page.
  • Linkable to content pages, external URLs or page anchors.
  • Allows an icon identifier to be configured for rendering an icon.
  • Style System support.
Location /apps/ehi-core/aem65/components/form/button/v1/button
sling:resourceSuperType core/wcm/components/form/button/v2/button
Supported AEM Versions 6.5
Editing Mode inPlaceEdit
Component Group Cheerios Experience
Use Object The Button component uses the com.adobe.cq.wcm.core.components.models.Button Sling model as its Use-object.



The Core Component Form Button component allows for the creation of button field, often to trigger the submission of the form and is intended to be used along with the Form Container component .


  • Provides support for regular and submit buttons

Client Libraries

The component provides a core.wcm.components.form.button.v2.editor editor client library category that includes JavaScript handling for dialog interaction. It is already included by its edit and design dialogs.

BEM Description

BLOCK cmp-form-button

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 Button component and are expected to be available as Resource properties:

  1. ./jcr:title - defines the text displayed on the button; if none is provided, the text will default to the button type
  2. ./name - defines the name of the button, which will be submitted with the form data
  3. ./value - defines the value of the button, which will be submitted with the form data

Edit Dialog Visual

Component Demo

  1. jcr:primaryType: nt:unstructured
  2. jcr:createdBy: admin
  3. jcr:title: Test Submit Button
  4. jcr:lastModifiedBy: admin
  5. jcr:created:
  6. name: test-button
  7. type: submit
  8. value: 10
  9. jcr:lastModified:
  10. sling:resourceType: ehi-core/aem65/components/form/button/v1/button