1
1
django-searchable-select
2
2
========================
3
3
4
+ .. Build Status:: https://travis-ci.org/and3rson/django-searchable-select.svg
5
+ .. Coverage Status:: https://coveralls.io/repos/github/and3rson/django-searchable-select/badge.svg
6
+
4
7
A better and faster multiple selection widget with suggestions for
5
8
Django
6
9
@@ -77,21 +80,22 @@ Installation
77
80
.. code :: python
78
81
79
82
from django import models, forms
80
- from models import MyModel
83
+ from searchableselect.widgets import SearchableSelect
84
+ from models import Traveler
81
85
82
- class MyModelForm (forms .ModelForm ):
86
+ class TravelerForm (forms .ModelForm ):
83
87
class Meta :
84
- model = models.MyModel
88
+ model = Traveler
85
89
exclude = ()
86
90
widgets = {
87
- ' cities ' : SearchableSelect(model = ' cities.City' , search_field = ' name' , many = True )
91
+ ' cities_visited ' : SearchableSelect(model = ' cities.City' , search_field = ' name' )
88
92
}
89
93
90
94
91
- class MyModelAdmin (admin .ModelAdmin ):
92
- form = Form
95
+ class TravelerAdmin (admin .ModelAdmin ):
96
+ form = TravelerForm
93
97
94
- admin.site.register(models.MyModel, MyModelAdmin )
98
+ admin.site.register(Traveler, TravelerAdmin )
95
99
96
100
Remember to **always ** initialize ``SearchableSelect `` with three
97
101
keyword arguments: ``model ``, ``search_field `` and ``many ``.
@@ -103,10 +107,15 @@ Installation
103
107
- ``many `` must be ``True `` for ``ManyToManyField `` and ``False ``
104
108
for ``ForeignKey ``.
105
109
110
+ Example app
111
+ ===========
112
+
113
+ Just run the project from `example ` directory, head to http://127.0.0.1:8000, login as ``admin ``/``admin `` and try adding Cats!
114
+
106
115
Known issues
107
116
============
108
117
109
- - Not tested with empty fields.
118
+ - Not tested with empty fields.
110
119
111
120
Contributing
112
121
============
@@ -117,4 +126,4 @@ License
117
126
=======
118
127
119
128
You are free to use this where you want as long as you keep the author
120
- reference. Please see LICENSE for more info.
129
+ reference. Please see LICENSE for more info.
0 commit comments