https://github.com/bashu/django-clearable-widget
👻 Custom widget to add a (x) clear button to your input fields
https://github.com/bashu/django-clearable-widget
django widgets
Last synced: 11 months ago
JSON representation
👻 Custom widget to add a (x) clear button to your input fields
- Host: GitHub
- URL: https://github.com/bashu/django-clearable-widget
- Owner: bashu
- License: bsd-3-clause
- Created: 2013-06-07T09:38:26.000Z (over 12 years ago)
- Default Branch: develop
- Last Pushed: 2021-12-02T06:31:50.000Z (about 4 years ago)
- Last Synced: 2025-03-10T16:39:35.924Z (11 months ago)
- Topics: django, widgets
- Language: Python
- Homepage:
- Size: 136 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
django-clearable-widget
=======================
.. image:: https://img.shields.io/pypi/v/django-clearable-widget.svg
:target: https://pypi.python.org/pypi/django-clearable-widget/
.. image:: https://img.shields.io/pypi/dm/django-clearable-widget.svg
:target: https://pypi.python.org/pypi/django-clearable-widget/
.. image:: https://img.shields.io/github/license/bashu/django-clearable-widget.svg
:target: https://pypi.python.org/pypi/django-clearable-widget/
.. image:: https://img.shields.io/travis/bashu/django-clearable-widget.svg
:target: https://travis-ci.com/github/bashu/django-clearable-widget/
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.
.. raw:: html
Installation
------------
First install the module, preferably in a virtual environment. It can be installed from PyPI:
.. code-block:: bash
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``:
.. code-block:: python
INSTALLED_APPS += (
'clearable_widget',
)
and just include ``clearable_widget`` templates
.. code-block:: html+django
{% 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:
.. code-block:: shell
python manage.py collectstatic
Usage
-----
All you need now is to import ``ClearableInput`` class and override
field's widget, for example:
.. code-block:: python
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.
Contributing
------------
If you like this module, forked it, or would like to improve it, please let us know!
Pull requests are welcome too. :-)
License
-------
``django-clearable-widget`` is released under the BSD license.