django-searchable-select 0.1

# django-searchable-select

A better and faster multiple selection widget with suggestions for Django

# What is this?

This plugin provides a replacement for standard multi-choice select on Django admin pages.

You can use this as custom widget for `ManyToManyField`.

# Features

- Filtering is performed on server side and thus significantly improves performance.
- Uses `Twitter Typeahead` to provide suggestion completion.
- Works **great** with ManyToMany fields that can be chosen from thousands of thousands of choices, e. g. `User - City` relations.

### Before


### After


# Installation

1. Install `django-searchable-select`.

```sh
$ pip install django-searchable-select
```

2. Add 'searchableselect' to your settings.

```python
# settings.py

INSTALLED_APPS = (
# ...
'searchableselect',
# ...
)
```

3. Add URL pattern required for the suggesting engine to your root `urls.py`.

```python
# urls.py

urlpatterns = patterns(
'',
# ...
url('^searchableselect/', include('searchableselect.urls')),
# ...
)
```

4. Use the widget in your model admin class:

```python
from django import models, forms
from models import MyModel

class MyModelForm(forms.ModelForm):
class Meta:
model = models.MyModel
exclude = ()
widgets = {
'cities': SearchableSelect(model='cities.City', search_field='name')
}


class MyModelAdmin(admin.ModelAdmin):
form = Form

admin.site.register(models.MyModel, MyModelAdmin)
```

Remember to **always** initialize `SearchableSelect` with two keyword arguments: `model` and `search_field`.

- `model` is the string in form `APP_NAME.MODEL_NAME` representing your model in the project, e. g. 'cities.City'
- `search_field` is the field within model that will be used to perform filtering, e. g. 'name'

# Known issues

- Not tested with `ForeignKey` fields.

# Contributing

I'm looking forward to bug reports and any kind of contribution.

# License

You are free to use this where you want as long as you keep the author reference.
Please see LICENSE for more info.