django-yaaac 4.1.0

Forms

What you need to do is to declare a custom ModelForm:

from django import forms
from django.contrib import admin
from django_yaaac.forms.fields import AutocompleteModelChoiceField
from . import models


class BandMemberForm(forms.ModelForm):
    band = AutocompleteModelChoiceField(site=admin.site,
                                        queryset=models.Band.objects.all(),
                                        yaaac_opts={
                                            "search_fields": ["^name"],
                                            "suggest_by": "get_full_name",
                                            "min_chars": 3,    # Fire search when 3 chars are sent (1 by default.)
                                            "max_height": 400, # 300px by default.
                                            "width": 250,      # 300px by default.
                                        },
                                        required=True)
    class Meta:
        model = models.BandMember

    class Media:
        # You need jQuery. Don't forget to call {{ form.media }} in your template.
        js = ('js/jquery.min.js', )


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

The site parameter of AutocompleteModelChoiceField is required for related lookup (the magnifier glass). The search_fields is a list of fields to search against using the same syntax as in Django Admin (^, $ etc). Extra options min_chars, max_height and width are the counter-part of minChars, maxHeight and width in Autocomplete options.

suggest_by is optional. It can be a field or a method of the model. By default, suggestions are shown using __unicode__ method.

If your model define a get_absolute_url() method, the label is a link to that resource.

Models

The Yaaac class must defines the following:

• user_passes_test is a class method that takes a user and return True or False.

• allows_suggest_by is a list of model fields or methods that can used as return value by the search view.

class BandMember(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)
    band = models.ForeignKey("Band", null=True, blank=True)
    favorite_instrument = models.ForeignKey("Instrument", null=True, blank=True)

    class Meta:
        unique_together = (('first_name', 'last_name'),)

    class Yaaac:
        user_passes_test = lambda instance, user: user and user.is_authenticated() or False
        allows_suggest_by = ['get_full_name']

    def __unicode__(self):
        return u"%s %s" % (self.first_name, self.last_name)

    def get_full_name(self):
        return u"%s %s" % (self.first_name, self.last_name)