Metadata-Version: 1.1
Name: django-intl-tel-input
Version: 0.1.3
Summary: A Django form widget implementing intl-tel-input.
Home-page: https://github.com/benmurden/django-intl-tel-input
Author: Benjamin Murden
Author-email: benmurden@github.com
License: BSD License
Description: Django intl-tel-input
        =====================
        
        .. image:: https://travis-ci.org/benmurden/django-intl-tel-input.svg?branch=master
          :target: https://travis-ci.org/benmurden/django-intl-tel-input
        .. image:: https://codecov.io/gh/benmurden/django-intl-tel-input/branch/master/graph/badge.svg
          :target: 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`_.
        
        This is a new package, so it doesn't implement all the features of
        intl-tel-input. However, it is well tested, and has been stable in production.
        
        Installation
        ------------
        
        Install from PyPI.
        
        .. code:: shell
        
            pip install django-intl-tel-input
        
        Add intl-tel-input to your INSTALLED\_APPS, so Django can find the init
        script.
        
        .. code:: python
        
            ...
            INSTALLED_APPS += ('intl_tel_input',)
            ...
        
        Usage
        -----
        
        Simply add ``IntlTelInputWidget`` to your form field.
        
        .. code:: 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:
        
        .. code:: 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`_, the static content will be inserted automatically beside the input. To prevent this, be sure to set ``include_media = False`` on your form helper.
        
        .. code:: 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.
        
        .. code:: javascript
        
            jQuery(document).ready(
              {{ form.media.js }}
            );
            
        All this assumes your form context variable is called ``form``.
        
        .. _intl-tel-input: https://github.com/jackocnr/intl-tel-input
        .. _crispy-forms: https://github.com/django-crispy-forms/django-crispy-forms
        
        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'``
        
        auto_geo_ip
          When True, `freegeoip`_ will be used to autodetect the user's country via Ajax. There is a limit of 15,000 queries per hour, so it should not be used on high-traffic sites. Alternatively use `pygeoip`_, detect server-side, then set the ``default_code``.
          Default: ``False``
        
        .. _freegeoip: https://freegeoip.net
        .. _pygeoip: https://pypi.python.org/pypi/pygeoip
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
