django-yaaac 0.91.1

Django application providing Ajax search capabilities.

Yaaac is lightweight Django application providing Ajax search to admin foreign-key form fields in addition to the raw_id_fields related lookup and - cerise sur le gateau - it is usable outside the admin.

Examples

In the admin

Configure the admin form to enable Ajax search where you usually use raw_id_fields.

Start typing to select a value from the suggestion.

The selected object is displayed using the unicode value. You can reset the field to choose another one.

In inlines as well.

Installation

Install the app from the source:

python setup.py build && (sudo) python setup.py install

Or with pip:

pip install django-yaaac

Add the app in your settings.INSTALLED_APPS:

INSTALLED_APPS = [
    ...,
    "django_yaaac",
    ...,
]

In the urls.py module of your project, define the url pattern for ajax calls:

import django_yaaac as yaaac
from django.conf.urls import patterns, include, url

urlpatterns = patterns('',
    url(r'^yaaac/', include(yaaac.autocomplete.urls)),
    ...
)

Usage

What you need to do is to declare a custom ModelForm and use it in your ModelAdmin:

from django import forms
from django.contrib import admin
from django.contrib.admin.templatetags.admin_static import static
from django.template import RequestContext
from django_yaaac.forms.fields import AutocompleteModelChoiceField
from test_app import models


class BandMemberForm(forms.ModelForm):
    band = AutocompleteModelChoiceField(site=admin.site,
                                        queryset=models.Band.objects.all(),
                                        yaaac_opts={
                                            "value_attr": "name"
                                        },
                                        required=True)
    class Meta:
        model = models.BandMember


class BandMemberAdmin(admin.ModelAdmin):
    form = BandMemberForm

    class Media:
        # You need jQuery.
        js = (static('js/jquery.min.js'), )


admin.site.register(models.BandMember, BandMemberAdmin)

The site parameter of AutocompleteModelChoiceField is required for related lookup (the magnifier glass). The value_attr is the model attribute used for the suggestions.