A reusable Django application for rendering forms with Foundation for Sites.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jérôme Lebleu 7236efe4b0 doc(README): add a depreciation notice 5 months ago
fsforms build: release v6.0.0 5 months ago
tests [test] Remove useless installed applications 1 year ago
.coveragerc [enh] Improve coverage's Makefile rule and report 2 years ago
.editorconfig [init] Add code, templates and doc with basic features and tests 2 years ago
.gitignore [ref] Build .rst files from Makefile and remove get_version 2 years ago
AUTHORS.md [doc] Switch to markdown for the README and other files 2 years ago
CHANGELOG.md build: release v6.0.0 5 months ago
LICENSE [init] Add code, templates and doc with basic features and tests 2 years ago
MANIFEST.in [ref] Build .rst files from Makefile and remove get_version 2 years ago
Makefile [enh] Improve coverage's Makefile rule and report 2 years ago
README.md doc(README): add a depreciation notice 5 months ago
manage.py [init] Add code, templates and doc with basic features and tests 2 years ago
requirements_test.txt [init] Add code, templates and doc with basic features and tests 2 years ago
runtests.py [ref] Simplify runtests.py and add python3.6 in tox 2 years ago
setup.cfg [ref] Build .rst files from Makefile and remove get_version 2 years ago
setup.py [ref] Build .rst files from Makefile and remove get_version 2 years ago
tox.ini test: update tested environments and versions 5 months ago

README.md

Foundation Forms for Django

Warning! This application is no longer maintained. As a nice and more powerfull alternative, you can switch to django-tapeforms.

A reusable Django application for rendering forms with Foundation for Sites.

Requirements

  • Python 3.5, 3.6 and 3.7
  • Django 2.0.x, 2.1.x and 2.2.x (Jinja2 is not supported yet)
  • Foundation for Sites 6.x

Note that this application does not include Foundation for Sites assets so that you can customize it as you need. Get started by reading its documentation!

Features

  • Displays the field label as well as its help text
  • Renders the Django base Widgets following the Forms component‘s guidelines
  • Shows the field errors as needed and sets the proper CSS classes on the field label and the input

Installation

  1. Install Foundation Forms for Django:

    pip install django-fsforms
    
  2. Add it to the INSTALLED_APPS in your settings.py:

    INSTALLED_APPS = (
        ...
        'fsforms',
        ...
    )
    
  3. Set the FORM_RENDERER in your settings.py to use fsforms’ one:

    • If you are using Django templates:

      FORM_RENDERER = 'fsforms.renderers.DjangoTemplates'
      
    • If you are using TemplateSetting as form renderer, you just have to ensure that the fsforms templates will be sourced before the built-in widgets templates directory.

    Note that this step is required since Django is loading templates first from the built-in form templates directory in django/forms when using those backends (see the Built-in-template form renderers’ doc).

Usage

In your template, you will just have to load fsforms then use the fsfield tag to render a form field.

{% load fsforms %}

<form action="/url/to/submit/" method="post">
  {% csrf_token %}
  <ul class="no-bullet">
    <li>{% fsfield form.simple_field %}</li>
    <li>{% fsfield form.other_field label_class="my-field" %}</li>
  </ul>
  <div class="button-holder">
    <button type="submit" class="button">Submit</button>
  </div>
</form>

Here are the special arguments you can pass to the fsfield tag:

  • show_label: a boolean which turns on or off the label output. Note that label of choices widgets will always be displayed.
  • label_class: a string which contains additional CSS classes to apply to the label element.
  • show_errors: a boolean which turns on or off the field errors’ output as well as the CSS classes applied to the elements - e.g. is-invalid-input and is-invalid-label. Default is True.
  • as_list: a boolean which controls the rendering of choices widgets - i.e. RadioSelect and CheckboxSelectMultiple. When set to True - the default, the fields will be rendered inline and wrapped inside a fieldset as suggested by the Forms component. Otherwise, they will be rendered as a list.

All the remaining arguments will be added to the widget attributes. As regards the required one, you can alter its value too but only with client-side effect. It means that if a field is defined as required in the form class and you pass required=False to the tag, it will appear as non-required to the user but will still be validated at the form's submission.

License

You can use this under GNU AGPLv3+. See LICENSE file for details.