djangocms-form-builder 0.1.1

Feedback

This project is in a early stage. All feedback is welcome! Please mail me at fsbraun(at)gmx.de

Also, all contributions are welcome.

Contributing

This is a an open-source project. We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We’re grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

Creating forms using django CMS’ structure board

First create a Form plugin to add a form. Each form created with help of the structure board needs a unique identifier (formatted as a slug).

Add form fields by adding child classes to the form plugin. Child classes can be form fields but also any other CMS Plugin. CMS Plugins may, e.g., be used to add custom formatting or additional help texts to a form.

from djangocms_form_builder import actions

@actions.register
class MyAction(actions.FormAction):
    verbose_name = _("Everything included action")

    def execute(self, form, request):
        ...  # This method is run upon successful submission of the form

Using (existing) Django forms with djangocms-form-builder

The Form plugin also provides access to Django forms if they are registered with djangocms-form-builder:

from djangocms_form_builder import register_with_form_builder

@register_with_form_builder
class MyGreatForm(forms.Form):
    ...

Alternatively you can also register at any other place in the code by running register_with_form_builder(AnotherGreatForm).

By default the class name is translated to a human readable form (MyGreatForm -> "My Great Form"). Additional information may be added using Meta classes:

@register_with_form_builder
class MyGreatForm(forms.Form):
    class Meta:
        verbose_name = _("My great form")  # can be localized
        redirect = "https://somewhere.org"  # string or object with get_absolute_url() method
        floating_labels = True  # switch on floating labels
        field_sep = "mb-3"  # separator used between fields (depends on css framework)

The verbose name will be shown in a Select field of the Form plugin.

Upon form submission a save() method of the form (if it has one). After executing the save() method the user is redirected to the url given in the redirect attribute.

Actions are not available for Django forms. Any actions to be performed upon submission should reside in its save() method.