Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Sometimes form.as_p doesn't cut it. This app adds more render methods to all forms. It also adds BEM style CSS classes to all form widgets and inputs.

Project description

Django Form Renderers

Sometimes form.as_p doesn’t cut it. This app adds more render methods to all forms.

Travis

Installation

  1. Install or add django-form-renderers to your Python path.
  2. Add form_renderers to your INSTALLED_APPS setting.

What it does

  1. Every form receives a div-based render method called as_div.
  2. If a field is required then an attribute required="required" is rendered for every widget. This is a safe blanket assumption.
  3. Optional - every field and input gets extra BEM CSS classes.

Defining your own renderers

Create either form_renderers.py or form_renderers/__init__.py in your app. Each renderer must be a function:

def as_some_renderer(form):
    return form._html_output(
        ...
    )

def as_another_renderer(form):
    return form._html_output(
        ...
    )

You can override the default as_div by creating a renderer called as_div in your app. The same rules that apply for Django template overriding apply to renderer overriding.

Replace as_p and / or as_table globally

Most third party apps use as_p or as_table for rendering. Replace it globally by setting:

FORM_RENDERERS = {"replace-as-p": True, "replace-as-table": True}

BEM

BEM is a CSS naming convention that advocates explicit naming over inheritance. Django forms, fields and widgets are not BEM aware. To enabled BEM classes from settings do:

FORM_RENDERERS = {"enable-bem-classes": True}

Authors

Praekelt Consulting

  • Hedley Roos

Changelog

0.3.2

  1. Django 1.10 tests pass. Handle Django 1.11 widget refactor gracefully.

0.3.1

  1. Add a setting allowing as_p and as_table to be overridden globally.

0.3

  1. Add a span tag hook for choice inputs. This allows CSS selectors to target the text inside the label tag.

0.2

  1. Optional BEM classes.
  2. Standardize as_div.

0.1.1

  1. Allow apps to specify custom renderers.

0.1

  1. First release.

Project details


Release history Release notifications

This version
History Node

0.3.2

History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1.1

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_form_renderers-0.3.2-py2.7.egg (15.9 kB) Copy SHA256 hash SHA256 Egg 2.7 May 3, 2017
django-form-renderers-0.3.2.tar.gz (9.0 kB) Copy SHA256 hash SHA256 Source None May 3, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page