Skip to main content

Autocompletion for django-tagging

Project description

django-tagging-autocomplete is a jquery based autocomplete solution for django-tagging.

Requirements

  • django-tagging

Setup

  1. Download package and install, for example using pip:

    pip install django-tagging-autocomplete
    
  2. Add tagging_autocomplete to installed apps in your project’s settings.

  3. 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

Project details


Download files

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

Files for django-tagging-autocomplete, version 0.5.1
Filename, size File type Python version Upload date Hashes
Filename, size django_tagging_autocomplete-0.5.1-py3-none-any.whl (78.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-tagging-autocomplete-0.5.1.tar.gz (53.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page