Skip to content

FormComponent

Jens Kooij edited this page Mar 25, 2018 · 3 revisions

FormComponent

Overview

The FormComponent is used for handling a form.

Sitemap Compatible Application Compatible Parameters
true true documentType, responseFolder, subTemplate, formParameterName, thankYouMessage, submitOncePerSession

Parameters

documentType

Required

The parameter documentType sets the documentType that should be used for generating the form.

responseFolder

Required

The parameter responseFolder sets the path in which the results of the form will be stored.

subTemplate

[Optional]

A template that will be used to render the html for the form. By default the same template will be used that generates the document form for editing in the cms.

formParameterName

[Optional]

By default formParameterName is set to "form", meaning that in the template the variable $form contains the rendered form.

thankYouMessage

[Optional]

By default thankYouMessage is set to "Thank you for sending us your response.". This is the text that will be shown after the form has been submitted.

submitOncePerSession

[Optional]

By default submitOncePerSession is set to false. This parameter defined wheter or not the same form can be submitted multiple times during the same session.

Example sitemap item

Title URL Regex Component Template Parameters
Contact Form /contact false FormComponent base documentType: "form-document"
responseFolder: "form-responses"
thankYouMessage: "Thank you for contacting us."

Parent

BaseComponent

Clone this wiki locally