https://github.com/bashu/django-charsleft-widget
👻 Custom widget that limits the number of characters that can be entered in a textarea field
https://github.com/bashu/django-charsleft-widget
django widgets
Last synced: 10 months ago
JSON representation
👻 Custom widget that limits the number of characters that can be entered in a textarea field
- Host: GitHub
- URL: https://github.com/bashu/django-charsleft-widget
- Owner: bashu
- License: bsd-3-clause
- Created: 2013-08-05T03:25:45.000Z (over 12 years ago)
- Default Branch: develop
- Last Pushed: 2021-12-02T06:31:40.000Z (about 4 years ago)
- Last Synced: 2025-03-23T21:11:16.231Z (11 months ago)
- Topics: django, widgets
- Language: Python
- Homepage:
- Size: 208 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
django-charsleft-widget
=======================
.. image:: https://img.shields.io/pypi/v/django-charsleft-widget.svg
:target: https://pypi.python.org/pypi/django-charsleft-widget/
.. image:: https://img.shields.io/pypi/dm/django-charsleft-widget.svg
:target: https://pypi.python.org/pypi/django-charsleft-widget/
.. image:: https://img.shields.io/github/license/bashu/django-charsleft-widget.svg
:target: https://pypi.python.org/pypi/django-charsleft-widget/
.. image:: https://img.shields.io/travis/bashu/django-charsleft-widget.svg
:target: https://travis-ci.com/github/bashu/django-charsleft-widget/
django-charsleft-widget is a custom widget that limits the number of characters that can be entered in a textarea 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-charsleft-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 ``charsleft_widget`` to ``INSTALLED_APPS``:
.. code-block:: python
INSTALLED_APPS += (
'charsleft_widget',
)
and just include ``charsleft_widget`` templates
.. code-block:: html+django
{% include "charsleft_widget/charsleft_widget_css.html" %} {# Before the closing head tag #}
{% include "charsleft_widget/charsleft_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 django.forms.fields import CharField
from charsleft_widget import CharsLeftArea
class Form(forms.Form):
field = CharField(max_length=128, widget=CharsLeftArea)
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-charsleft-widget`` is released under the BSD license.