django-tagging-autocomplete
django-tagging-autocomplete copied to clipboard
jquery-autocomplete widget for django-tagging
=========================== django-tagging-autocomplete
django-tagging-autocomplete is a jquery based autocomplete solution for django-tagging.
Requirements
- django-tagging
Setup
-
Download package and install, for example using pip::
pip install django-tagging-autocomplete
-
Add
tagging_autocomplete
to installed apps in your project's settings. -
Add the following line to your project's urls.py file::
(r'^tagging_autocomplete/', include('tagging_autocomplete.urls')),
Usage
The Model Field
You can use TagAutocompleteField()
to enable autocompletion right in your
models.py
. In most cases this is the easiest solution::
from django.db import models
from tagging_autocomplete.models import TagAutocompleteField
class SomeModel(models.Model):
tags = TagAutocompleteField()
The Form Widget
Alternatively you can use the TagAutocomplete()
form widget while creating
your form::
from django import forms
from tagging.forms import TagField
from tagging_autocomplete.widgets import TagAutocomplete
class SomeForm(forms.Form):
tags = TagField(widget=TagAutocomplete())
Optional settings
By default the maximum number of results suggested by the autocompletion is 100.
You can modify this number by adding to your settings.py
project file
the TAGGING_AUTOCOMPLETE_MAX_RESULTS
constant.
For example::
TAGGING_AUTOCOMPLETE_MAX_RESULTS = 5
By default autocompletion suggests tags that start with a given term.
In case you need to show ones that contain the given term,
set TAGGING_AUTOCOMPLETE_SEARCH_CONTAINS
to True
.
For example::
TAGGING_AUTOCOMPLETE_SEARCH_CONTAINS = True
By default suggestions are shown right after you enter first character.
You can configure this behaviour using TAGGING_AUTOCOMPLETE_MIN_LENGTH
.
For example::
TAGGING_AUTOCOMPLETE_MIN_LENGTH = 3