volto-form-block

Volto addon which adds a customizable form using a block. Intended to be used with collective.volto.formsupport.

Install with mrs-developer (see Volto docs) or with:

yarn add volto-form-block volto-subblocks

Note: Since version v2.0.0 of this addon, it's required collective.volto.formsupport 2.0.0 or higher (and its upgrade steps).

Note: Since version v2.1.2 of this addon, it's required Volto 14.2.0

Note: Since version v3.0.0 of this addon, it's required Volto >= 16.0.0-alpha.38

Features

This addon will add in your project the Form block and the needed reducers.

Using the engine of subblocks, you can manage form fields adding, sorting and deleting items.

For each field, you can select the field type from:

• Text
• Textarea
• Select
• Single choice (radio buttons)
• Multiple choice (checkbox buttons)
• Checkbox
• Date picker
• File upload with DnD
• E-mail
• Static rich text (not a fillable field, just text to display between other fields)

For every field you can set a label and a help text. For select, radio and checkbox fields, you can select a list of values.

Captcha verification

This form addon is configured to work with HCaptcha, ReCaptcha and NoRobot to prevent spam.

In order to make one of these integrations work, you need to add https://github.com/plone/plone.formwidget.hcaptcha and/or https://github.com/plone/plone.formwidget.recaptcha and/or https://github.com/collective/collective.z3cform.norobots Plone addon and configure public and private keys in controlpanels.

HCaptcha

With HCaptcha integration, you also have an additional option in the sidebar in 'Captcha provider' to enable or disable the invisible captcha (see implications here).

In some test scenarios it's found that the "Passing Threshold" of HCaptcha must be configured as "Auto" to get the best results. In some test cases if one sets the Threshold to "Moderate" HCaptcha starts to fail.

Export

With backend support, you can store data submitted from the form. In Edit, you can export and clear stored data from the sidebar.

Additional fields

In addition to the fields described above, you can add any field you want. If you need a field that is not supported, PRs are always welcome, but if you have to use a custom field tailored on your project needs, then you can add additional custom fields.

config.blocks.blocksConfig.form.additionalFields.push({
  id: 'field type id',
  label:
    intl.formatMessage(messages.customFieldLabel) ||
    'Label for field type select, translation obj or string',
  component: MyCustomWidget,
  isValid: (formData, name) => true,
});

The widget component should have the following firm:

({
  id,
  name,
  title,
  description,
  required,
  onChange,
  value,
  isDisabled,
  invalid,
}) => ReactElement;

You should also pass a function to validate your field's data. The isValid function accepts formData (the whole form data) and the name of the field, thus you can access to your fields' data as formData[name] but you also have access to other fields.

isValid has the firm:

(formData, name) => boolean;

Example custom field here.

Static fields

In backend integration, you can add in block data an object called static_fields and the form block will show those in form view as readonly and will aggregate those with user compiled data.

i.e.: aggregated data from user federated authentication:

Upgrade guide

To upgrade to version 2.4.0 you need to:

• remove the env vars
• install https://github.com/plone/plone.formwidget.hcaptcha or https://github.com/plone/plone.formwidget.recaptcha or both in Plone.
• insert private and public keys in Plone HCaptcha controlpanel or/and Plone ReCaptcha controlpanel.

Video demos

• Form usage
• Form editing
• Export stored data

VERSIONS

With volto-form-block@2.5.0 you need to upgrade collective.volto.formsupport to version 2.4.0

Development

You can develop an add-on in isolation using the boilerplate already provided by the add-on generator. The project is configured to have the current add-on installed and ready to work with. This is useful to bootstrap an isolated environment that can be used to quickly develop the add-on or for demo purposes. It's also useful when testing an add-on in a CI environment.

It's quite similar when you develop a Plone backend add-on in the Python side, and embed a ready to use Plone build (using buildout or pip) in order to develop and test the package.

The dockerized approach performs all these actions in a custom built docker environment:

1. Generates a vanilla project using the official Volto Yo Generator (@plone/generator-volto)
2. Configures it to use the add-on with the name stated in the package.json
3. Links the root of the add-on inside the created project

After that you can use the inner dockerized project, and run any standard Volto command for linting, acceptance test or unit tests using Makefile commands provided for your convenience.

Setup the environment

Run once

make dev

which will build and launch the backend and frontend containers. There's no need to build them again after doing it the first time unless something has changed from the container setup.

In order to make the local IDE play well with this setup, is it required to run once yarn to install locally the required packages (ESlint, Prettier, Stylelint).

Run

yarn

Build the containers manually

Run

make build-backend
make build-addon

Run the containers

Run

make start-dev

This will start both the frontend and backend containers.

Stop Backend (Docker)

After developing, in order to stop the running backend, don't forget to run:

Run

make stop-backend

Linting

Run

make lint

Formatting

Run

make format

i18n

Run

make i18n

Unit tests

Run

make test

Acceptance tests

Run once

make install-acceptance

For starting the servers

Run

make start-test-acceptance-server

The frontend is run in dev mode, so development while writing tests is possible.

Run

make test-acceptance

To run Cypress tests afterwards.

When finished, don't forget to shutdown the backend server.

make stop-test-acceptance-server

Release

Run

make release

For releasing a RC version

Run

make release-rc