Form Introduction Behavior

  • HST Behavior class = com.onehippo.cms7.eforms.hst.behaviors.FormIntroBehavior
  • CMS Plugin class = com.onehippo.cms7.eforms.cms.extensions.FormIntroductionPlugin

Overview

The Form Introduction behavior adds an introduction text field to the form editor in Bloomreach Content. The introduction text is stored in the form document and made available during form rendering.

Form introduction field with example event text in editor

When to Use

Use the Form Introduction behavior when you want to display introductory text at the top of a form. This text can provide context or instructions for users completing the form.

CMS Configuration

To enable the Form Introduction plugin in the form editor:

  1. In the JCR repository, navigate to
    /hippo:namespaces/eforms/form/editor:templates/_default_.

  2. Add a new node of type frontend:plugin.

  3. Set the following properties on the new node:

    • plugin.class = com.onehippo.cms7.eforms.cms.extensions.FormIntroductionPlugin
    • mode = ${mode}
    • wicket.id = ${cluster.id}.extensions.item
    • wicket.model = ${wicket.model}

Bloomreach CMS plugin configuration for form introduction behavior

Note:
You can add the plugin to a custom form template instead of the default eforms:form template if needed.

HST Configuration

To activate the Form Introduction behavior in your form component:

  1. Open the HST component configuration for your form.

  2. Add the following parameter:

    • behaviors = com.onehippo.cms7.eforms.hst.behaviors.FormIntroBehavior

HST component configuration with FormIntroBehavior parameter value

Request Attributes

The Form Introduction behavior implements DoBeforeRenderBehavior and sets the following request attribute:

  • formIntro (String): Contains the value of the introduction text area defined in the form document.

Demo

You can view an example implementation in the Enterprise Forms demo:

Share Feedback
Page: /build/enterprise-plugins/enterprise-forms/form-introduction-behavior
Section: Build
Category *