Django application to add 'django-crispy-forms' layout objects for the GOV.UK Design System.
Project description
A GOV.UK Design System template pack for django-crispy-forms, for simple and powerful form generation which is compliant with GDS usability and accessibility guidelines.
Requires Django 2.2 or later and django-crispy-forms 1.9 or later.
This template pack supports govuk-frontend 3.5 or later.
Quickstart
This is a minimal howto without options or details - see the crispy-forms-gds documentation for full instructions for installation and usage.
Install using pip:
pip install crispy-forms-gds
Add to installed apps, with settings to tell django-crispy-forms to use this theme:
INSTALLED_APPS = [ ... 'crispy_forms', 'crispy_forms_gds', ] CRISPY_ALLOWED_TEMPLATE_PACKS = ["gds"] CRISPY_TEMPLATE_PACK = "gds"
Build a regular crispy form using layout objects from crispy_forms_gds:
from django import forms from crispy_forms_gds.helper import FormHelper from crispy_forms_gds.layout import Submit class TextInputForm(forms.Form): name = forms.CharField( label="Name", help_text="Your full name.", widget=forms.TextInput(), error_messages={ "required": "Enter your name as it appears on your passport" } ) def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.helper = FormHelper() self.helper.add_input(Submit("submit", "Submit"))
Render the form in your templates as normal:
{% load crispy_forms_tags %} {% crispy form %}
Open the page in your browser:
Features
The template pack supports all the basic components listed in the GOV.UK Design System:
Demo
If you checkout the code from the repository, there is a Django site you can run to see the forms in action. You will need to install nvm first (to manage node versions), then build and run the demo with:
make serve
Further reading
Read the documentation on Read the docs
Download the PyPi package
Learn more about Django Crispy Forms
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for crispy_forms_gds-0.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02745ec7013f17dbcbc19ed1cc82fafdcb621773ae0eabf0ecc3c90d89441a4d |
|
MD5 | e8395df3f43708b2f46773d7b0a30ea6 |
|
BLAKE2b-256 | 0405262d74b0e76b9c6150b37c357ad149a5d2b0d737cddb48891dc272b7dfe6 |