django-intl-tel-input 0.4.0
A Django form widget implementing intl-tel-input.
License: BSD License

Django intl-tel-input
=====================

[![Build Status](https://travis-ci.org/benmurden/django-intl-tel-input.svg?branch=master)](https://travis-ci.org/benmurden/django-intl-tel-input)
[![Code coverage](https://img.shields.io/codecov/c/github/benmurden/django-intl-tel-input.svg)](https://codecov.io/gh/benmurden/django-intl-tel-input)

A Django form widget for international telephone numbers based on the
jQuery plugin [intl-tel-input](https://github.com/jackocnr/intl-tel-input).

This package is pre 1.0, so doesn't implement every feature of intl-tel-input. However, it is well tested, and has been stable in production.

## Version support

Tested on the following versions of Python and Django.

| Package | Version support         |
| ------- | ----------------------- |
| Python  | 2.7, 3.4, 3.5, 3.6, 3.7 |
| Django  | 1.11, 2.0, 2.1          |

## Installation

Install from PyPI.

```shell
pip install django-intl-tel-input
```

Add intl-tel-input to your `INSTALLED_APPS`, so Django can find the init
script.

```python
...
INSTALLED_APPS += ('intl_tel_input',)
...
```

## Usage

Simply add `IntlTelInputWidget` to your form field.

```python
from intl_tel_input.widgets import IntlTelInputWidget

class MyForm(forms.ModelForm):
    class Meta:
        model = MyModel
        fields = ['foo', 'bar']
        widgets = {
            'bar': IntlTelInputWidget()
        }
...
```

With a standard form:

```python
class MyForm(forms.Form):
    tel_number = forms.CharField(widget=IntlTelInputWidget())

...
```

## Form media

Include `{{ form.media.css }}` in the `<head>` of your template. This
will ensure all styles are parsed before the widget is displayed.

If you have included jQuery at the end of your document, then don't
forget to update the template where this widget appears with a
`{{ form.media.js }}`. Put it in a block that allows it to come after
jQuery.

If you're using
[crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms),
the static content will be inserted automatically beside the input. To
prevent this, be sure to set `include_media = False` on your form
helper.

```python
class MyForm(forms.Form):
...
    def __init__(self, *args, **kwargs):
        self.helper = FormHelper()
        self.helper.include_media = False
...
```

If you need to load all JS in the head, you can make the `init.js`
script wait for the document to be ready with the following snippet.

```javascript
jQuery(document).ready(
  {{ form.media.js }}
);
```

All this assumes your form context variable is called `form`.

## Options

The widget can be invoked with keyword arguments which translate to the
options available in intl-tel-input.

### allow\_dropdown
Shows the country dropdown.
Default: `True`

### default\_code
Country code selected by default. Overridden when using `auto_geo_ip`.
Default: `'us'`

### preferred\_countries
Array of countries that will always appear at the top of the dropdown.
Default: `['us', 'gb']`

### use\_default\_init
Use the provided init.js to initialize the plugin. Set this to `False` 
if you want to provide your own initialization for the plugin. This is 
useful if, for example, you have your own GeoIP implementation you'd 
like to use.
Default: `True`