django-input-mask 1.3.6

JavaScript input masks for Django

Django Input Mask

A collection of easy-to-extend-widgets for applying masks to input elements.

MIT licensed

Compatibility

• Django 1.3, 1.4 and 1.5

• Python 2.6, 2.7 and 3

Requirements

• jQuery 1.8 or higher

We do not include jQuery in this package, you must add it by your hands.

Note: jQuery 1.9 support will be granted through the jQuery Migrate Plugin.

Just take a look on example_project/templates/form.html file for an example.

Installation

pip install django-input-mask

Or install directly from master branch:

pip install git+http://github.com/caioariede/django-input-mask.git#egg=input_mask

Or manually place it on your PYTHON_PATH.

Configuration

Add input_mask to the INSTALLED_APPS setting.

This is needed so that Django can handle the app’s static files

Usage

from django import forms
from django.contrib.localflavor.br.forms import BRPhoneNumberField

from input_mask.contrib.localflavor.br.widgets import BRPhoneNumberInput

class YourForm(forms.ModelForm):
    phone = BRPhoneNumberField(widget=BRPhoneNumberInput)

Decimal masks

from input_mask.fields import DecimalField

class MyForm(forms.ModelForm):
    my_decimal_field = DecimalField(max_digits=10, decimal_places=2)

• input_mask.fields.DecimalField will automatically handle separators.

• input_mask.contrib.localflavor.*.fields.*DecimalField will use local-based separators.

Creating your own masks

from input_mask.widgets import InputMask

class MyCustomInput(InputMask):
    mask = {'mask': '999-111'}

For more rules, take a look at meioMask documentation.