Skip to main content

Custom widget to add a (x) clear button to your input fields

Project description

django-clearable-widget is a custom widget that adds a input clearing button on any input fields that are using it. It clears the value, and returns focus to that field.

Authored by Basil Shubin

https://img.shields.io/pypi/v/django-clearable-widget.svg https://img.shields.io/pypi/dm/django-clearable-widget.svg https://img.shields.io/github/license/bashu/django-clearable-widget.svg https://img.shields.io/travis/bashu/django-clearable-widget.svg

Installation

pip install django-clearable-widget

External dependencies

  • jQuery - this is not included in the package since it is expected that in most scenarios this would already be available.

Setup

Add clearable_widget to INSTALLED_APPS:

INSTALLED_APPS += (
    'clearable_widget',
)

and just include clearable_widget templates

{% include "clearable_widget/clearable_widget_css.html" %} {# Before the closing head tag #}
{% include "clearable_widget/clearable_widget_js.html" %} %} {# Before the closing body tag #}

When deploying on production server, don’t forget to run:

python manage.py collectstatic

Usage

All you need now is to import ClearableInput class and override field’s widget, for example:

from clearable_widget import ClearableInput

class Form(forms.Form):

    field = forms.CharField(widget=ClearableInput)

Please see example application. This application is used to manually test the functionalities of this package. This also serves as a good example.

You need only Django 1.4 or above to run that. It might run on older versions but that is not tested.

License

django-clearable-widget is released under the BSD license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-clearable-widget-0.1.5.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

django_clearable_widget-0.1.5-py2.py3-none-any.whl (8.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-clearable-widget-0.1.5.tar.gz.

File metadata

File hashes

Hashes for django-clearable-widget-0.1.5.tar.gz
Algorithm Hash digest
SHA256 692b181fd9748e57abb0466cb2ab7a8475efd99c9654b1f902c2cf39a2dcd85f
MD5 a375ddcb192dae5bb593d2f628636ed1
BLAKE2b-256 35e97e44c1ffadb110032a2e67be9de52ce23c6e4313d1b9a1cb72392ceaf1c5

See more details on using hashes here.

Provenance

File details

Details for the file django_clearable_widget-0.1.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_clearable_widget-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3855df2b30f61b9d99e52264484285ee9a26e7381915a8580e5b647cf18d4958
MD5 f0ce34f1dfe9aa2483635cfe02e802a8
BLAKE2b-256 52d68d4ce0e3545324312eb35ad3216b2f75f1c0641b8d2c99e0becbfa97f077

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page