Skip to main content

Django app for client-side form validation. Wrapper for parsley.js

Project description

Downloads Latest Release Build Status Coverage Status

What is it?

Parsleyjs is a JavaScript library to do client side data validations. It does this in a non-intrusive way via adding a parsley-* attributes to form fields.

When you define a Django form, you get server side validations for free using the form field attributes. Django-parsley adds these validations to client side, by tagging your form with parsley-* attributes.

Parsley plays well with crispy-forms et all.

Installation

  1. pip install django-parsley (or add to your requirements.txt)
  2. add parsley to your INSTALLED_APPS (required for static files)

Upgrading

Upgrading from 0.2 to 0.3:

If you’re using parsley.js 1.x, make sure to set the parsley_namespace Meta attribute to parsley for backward compatibility.

class Meta:
    parsley_namespace = 'parsley'

Usage

parsley provides a single class decorator called parsleyfy. Decorate your Form or ModelForm with parsleyfy to get the validations.

Eg.

from parsley.decorators import parsleyfy


@parsleyfy
class FieldTypeForm(forms.Form):
    name = forms.CharField(min_length=3, max_length=30)
    url = forms.URLField()
    url2 = forms.URLField(required=False)
    email = forms.EmailField()
    email2 = forms.EmailField(required=False)
    age = forms.IntegerField()
    income = forms.DecimalField()

Your rendered form’s HTML will look like this

<p><label for="id_name">Name:</label> <input parsley-required="true" parsley-minlength="3" maxlength="30" type="text" parsley-maxlength="30" id="id_name" name="name" /></p>
<p><label for="id_url">Url:</label> <input type="text" parsley-required="true" parsley-type="url" name="url" id="id_url" /></p>
<p><label for="id_url2">Url2:</label> <input type="text" parsley-type="url" name="url2" id="id_url2" /></p>
<p><label for="id_email">Email:</label> <input type="text" parsley-required="true" parsley-type="email" name="email" id="id_email" /></p>
<p><label for="id_email2">Email2:</label> <input type="text" parsley-type="email" name="email2" id="id_email2" /></p>
<p><label for="id_age">Age:</label> <input type="text" parsley-required="true" parsley-type="digits" name="age" id="id_age" /></p>
<p><label for="id_income">Income:</label> <input type="text" parsley-required="true" parsley-type="number" name="income" id="id_income" /></p>

Note the parsley-* attributes.

You could also do

FieldTypeForm = parsleyfy(FieldTypeForm)

Which is the same thing.

Put this form inside a

<form parsley-validate>
    {{ form.as_p }}
</form>

Note

Make sure jquery.js and parsley.js are included in the template.

Admin

To add parsley validations to admin, use the ParsleyAdminMixin with your ModelAdmin like so:

class StudentAdmin(ParsleyAdminMixin, admin.ModelAdmin):
    pass

Note

Use the parsley.django-admin.js helper from parsley static to auto-validate admin forms.

Advanced Usage

In addition to the default validators if you want to add extra client side validations or if you want to add custom validators, add a parsley_extras Meta attribute. For e.g if you wanted to add minlength and equalto validations on a PasswordChangeForm:

@parsleyfy
class PasswordChangeForm(BasePasswordChangeForm):
    class Meta:
        parsley_extras = {
            'new_password1': {
                'minlength': "5",
            },
            'new_password2': {
                'equalto': "new_password1",
                'error-message': "Your passwords do not match.",
            },
        }

To use a custom namespace for parsley (e.g when using parsley with the data-parsley-namespace option) you can provide a namespace by using the parsley_namespace Meta attribute.

class Meta:
    parsley_namespace = 'custom'

License

3 Clause BSD.

Bug report and Help

For bug reports open a github ticket. Patches gratefully accepted. Need help? Contact us here

Project details


Release history Release notifications

History Node

0.7

History Node

0.6

This version
History Node

0.5

History Node

0.4

History Node

0.3

History Node

0.2

History Node

0.2a

History Node

0.1

History Node

0.0.2a0

History Node

0.0.1a0

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-parsley-0.5.tar.gz (36.4 kB) Copy SHA256 hash SHA256 Source None Mar 20, 2014

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