Magnolia 5.3 reached end of life on June 30, 2017. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

Form module allows you to create forms that provide validation, log and mail functionality. The module provides pre-configured form templates for easy creation of customized and standard form types (contact etc.) forms. Multiple form elements that belong together, such as address fields, can be grouped. Form data can be validated using configurable validators. Sections and elements in a form are set using component definitions. Note that forms adhere to business logic largely defined by W3C Recommendations. Form component definitions and their corresponding dialog definitions are configured in the Configuration app > modules/form/templates/components and /form/dialogs.

Node nameValue

 modules

 

 form

 

 config

 

 templates

 

 components

 

 form

 

 formEdit

 

 formStep

 

 formHidden

 

 formSubmit

 

 formSummary

 

 formPassword

 

 formHoneypot

 

 formGroupEdit

 

 formCondition

 

 formSelection

 

 formGroupFields

 

 formGroupEditItem

 

 dialogs

 

 

Form

  • All standard forms have a Form Settings component that defines form behavior.
  • Component is generated automatically by the template.
  • Form settings include where to submit the data and confirmation email on submission.
  • Only form title and introductory text displayed to visitor.
  • Component definition: form

File

  • Upload file component.
  • In multi-step forms this is only available on the last step.
  • Component definition: formFile

Text field

  • Single line text input or textarea.
  • Component definition: formEdit

Additional step

  • Additional step in a multi-step form.
  • Used for grouping fields on another page.
  • Keeps data from all previous steps.
  • Component definition: formStep

Hidden field

  • Single hidden line input or textarea.
  • Does not render on the page.
  • Used to pass on values to the form processors in the same way as other data entered by a user.
  • Component definition: formHidden

Submit button

  • Submits the form.
  • Can be labelled as required.
  • Component should be inserted at the end of the form.
  • Component definition: formSubmit

Form summary

  • Displays a table with the parameters and/or values sent by the Form Step
  • Component definition: formSummary

Password field

  • Single line password input or textarea.
  • Identical to the Text field component, but input is masked by of dots.
  • Component definition: formPassword

Users are allowed to enter HTML-like characters such as ampersand (&) into the password field. You can control HTML escaping with the escapeHtml property in the component definition. For the password field this property is set to false by default and will not escape HTML characters.

Honeypot field

  • This is an invisible field that you can add to the page to intercept bot attacks.
  • No Validator or max length.
  • Component definition: formHoneypot

Text field group

  • Groups text fields in the same line.
  • The Group dialog has a single Group Name field that does not render on the page. Assign this name to reference the group with FreeMarker tags.
  • The subcomponents are Text Field components.
  • Component definition: formGroupEdit

Condition list

  • Optional business logic step in a multi-step form.
  • Added automatically with Submit button, but as an optional area.
  • If required click the grey Condition List Placeholder area to set the condition for selecting the next form step.
  • Component definition: formCondition
     
      

Selection

  • Checkbox, select (single/multiple) and radio buttons.
  • Component definition: formSelection

Field set

  • Groups multiple form fields together.
  • Main component and individual field components are created as subcomponents.
  • Multiple field sets possible, as required.
  • Enables inclusion of a title field, useful to distinguish field sets or include introductory text.
  • Typical use is one field set for address fields and another for payment details.
  • Component definition: formGroupFields

Text field in a group

  • Single text field in a group on the same line.
  • Component definition: formGroupEditItem

  • No labels