The add on collective.easyform adds Plone content types for form creation.
EasyForm provides a Plone form builder through-the-web using fields, widgets, actions and validators (based on Dexterity).
Form input can be saved or emailed. A simple and user-friendly interface allows non-programmers to create custom forms.
Install collective.easyform by adding it to your buildout:
[buildout]
...
eggs =
collective.easyformRun buildout:
bin/buildoutThe last step is to activate EasyForm in the Add-ons control panel.
With PloneFormGen installed, open the following url:
@@migrate-ploneformgen
- Choose EasyForm from the toolbars 'Add new' menu. Insert form title, description and other settings.
- Add fields or fieldsets to create a unique form that will meet your particular requirements.
There are enough basic field types to satisfy any demands:
- File Upload
- Text line (String)
- Integer
- Yes/No
- Date, Date/Time
- Floating-point number
- Choice
- Rich Text
- Image
- Multiple Choice
- Text
- Password
- ReСaptcha
- Continue to customize form by setting the order of fields, defining required and hidden ones, choosing validator, if necessary, and other field type specific settings.
Click on the picture below for a short introduction video:
Under Advanced > field depends on, you can define conditions to hide a field and only fade it in when a condition is fulfilled. We are using pat-depends here, all options are documented in the pat-depends docs.
You can also set a CSS class string for every field under Advanced > CSS Class.
Since the form is marked with the row css class you can use the existing Bootstrap 5 CSS column classes for the fields
to create simple column layouts. See the Bootstrap Grid System documentation
for more information.
For more complex layouts you can also add your own CSS classes and definitions. Here is one example CSS to define a form with up to 4 columns and different col span for individual fields.
.easyformForm fieldset{
display: grid;
gap: 1em;
grid-template-columns: 1fr 1fr 1fr 1fr;
}
.easyformForm .field{
background-color: #eeeeee;
padding: 0.5em;
grid-column: auto / span 2;
}
.easyformForm fieldset > p:first-of-type{
background-color: transparent;
grid-column: auto / span 4;
}
.easyformForm .field.formCol14{
grid-column: auto / span 1;
}
.easyformForm .field.formCol34{
grid-column: auto / span 3;
}
.easyformForm .field.formCol44{
grid-column: auto / span 4;
}Install collective.easyform with the recaptcha extra:
[buildout]
...
eggs =
collective.easyform [recaptcha]Run buildout. In the Add-ons control panel, activate both EasyForm and the ReCaptcha widget.
In the ReCaptcha control panel, set the public key and private key values you obtained from https://developers.google.com/recaptcha/ (you can use reCAPTCHA V2).
In the EasyFrom control panel (/@@easyform-controlpanel), add the "ReCaptcha" field to "Allowed Fields".
Alternatively, activate it by adding it as an registry.xml entry for Generic Setup:
<record name="easyform.allowedFields">
<value purge="False">
<element>collective.easyform.fields.ReCaptcha</element>
</value>
</record>Add the ReCaptcha field to the forms where you want to use it.
Use the field type ReCaptcha and leave require unchecked.
As a last step you might want to avoid including the recaptcha field in the thank you page and in the mailer action. To do that, edit the form, go to the "Thanks page" settings, disable "Show all fields" and then include only those you want. Likewise for the mailer: open the form actions via the Actions toolbar menu and edit the mailer settings accordingly.
Install collective.easyform with the norobots extra:
[buildout]
...
eggs =
collective.easyform [norobots]Run buildout. In the Add-ons control panel, install EasyForm.
In the EasyFrom control panel (/@@easyform-controlpanel), add the "NorobotCaptcha" field to "Allowed Fields".
Alternatively, activate it by adding it as an registry.xml entry for Generic Setup:
<record name="easyform.allowedFields">
<value purge="False">
<element>collective.easyform.fields.NorobotCaptcha</element>
</value>
</record>Add the NorobotCaptcha field to the forms where you want to use it.
Use the field type NorobotCaptcha and leave require unchecked.
As a last step you might want to avoid including the norobotcaptcha field in the thanks page and the mailer action. To do that, edit the form, go to the "Thanks page" settings, disable "Show all fields" and then include only those you want. Likewise for the mailer: open the form actions via the Actions toolbar menu and edit the mailer settings accordingly.
Install collective.easyform with the downloadxlsx extra:
[buildout]
...
eggs =
collective.easyform [downloadxlsx]This gives you the option to download the saved data as XLSX using openpyxl to generate the XLSX file.
You can choose between the following actions after form submission:
- Mailer
- DataStorage
- CustomScript
The mailer stores a HTML template for sending the results of the form. You can override it with a file named easyform_mail_body_default.pt in your site. If it is not found the default from the default_schemata directory of this package is taken. If you plan to override start with the the mail_body_default.pt file and make sure it is a valid pagetemplate.
This add-on has been translated into
- Basque
- Brazilian Portuguese
- Deutsch
- Dutch
- English
- French
- Italian
- Japanese
- Spanish
- Ukrainian
Note: This Plone package is similar to Archetypes based Products.PloneFormGen for Plone versions 1 to 4. Now, Dexterity is the default framework for building content types in Plone 5. collective.easyform is based on Dexterity.
If you want to help with the development (improvement, update, bug-fixing, ...) of collective.easyform this is a great idea!
You can clone it or get access to the github-collective and work directly on the project.
Please do larger changes on a branch and submit a Pull Request.
Maintainer of collective.easyform is the Plone Collective community.
We appreciate any contribution !
For new release, please contact one of the owners or maintainers mentioned at the Python Package Index page.
- Issue Tracker: https://github.com/collective/collective.easyform/issues
- Source Code: https://github.com/collective/collective.easyform
The project is licensed under the GPLv2.
- 1.x targets Plone 4.x
- 2.x targets Plone 5.x onwards
- 3.x targets Plone 5.2
- 4.x targets Plone 6, on Python 3