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.
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.
Changes
1.0.0 (2021-11-30)
Added Django 3+ support.
Dropped Python 2.7 support.
Dropped Django 1.10 / 1.11 support.
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
Built Distribution
Hashes for django-clearable-widget-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 435423c678aab20198b3d1b9cb3ab079ff401b911ba39bb6d7b08a902fc59f23 |
|
MD5 | 167bb80c156004d0001ada8fa77d7c0f |
|
BLAKE2b-256 | afe552dafaa9a0e81b24fe86f4bc3b268bb9f83ba26df7b7572d7b53e2b21f2e |
Hashes for django_clearable_widget-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 582d44de72a4c05a067512514d0ae3e88087e8754a02ed67340e0b27ba6ca5b9 |
|
MD5 | d6957f7fae48dc9b4b9e77cd11a71524 |
|
BLAKE2b-256 | c806dba73e3db91e35a338b163f1760566f93b0f0faf6bf3ca4f527ede02ca23 |