1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
"""Settings for Django-Select2."""
from appconf import AppConf
from django.conf import settings # NOQA
__all__ = ("settings", "Select2Conf")
class Select2Conf(AppConf):
"""Settings for Django-Select2."""
LIB_VERSION = "debian"
"""Version of the Select2 library."""
CACHE_BACKEND = "default"
"""
Django-Select2 uses Django's cache to sure a consistent state across multiple machines.
Example of settings.py::
CACHES = {
"default": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://127.0.0.1:6379/1",
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
},
'select2': {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": "redis://127.0.0.1:6379/2",
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
}
}
# Set the cache backend to select2
SELECT2_CACHE_BACKEND = 'select2'
.. tip:: To ensure a consistent state across all you machines you need to user
a consistent external cache backend like Memcached, Redis or a database.
.. note::
Should you have copied the example configuration please make sure you
have Redis setup. It's recommended to run a separate Redis server in a
production environment.
.. note:: The timeout of select2's caching backend determines
how long a browser session can last.
Once widget is dropped from the cache the json response view will return a 404.
"""
CACHE_PREFIX = "select2_"
"""
If you caching backend does not support multiple databases
you can isolate select2 using the cache prefix setting.
It has set `select2_` as a default value, which you can change if needed.
"""
JS = "django_select2/select2.js/select2.js"
"""
The URI for the Select2 JS file. By default this points to a local copy linked
to the libjs-select2.js Debian package, to be served via staticfiles.
If you want to select the version of the JS library used, or want to serve it from
the local 'static' resources, add a line to your settings.py like so::
SELECT2_JS = 'assets/js/select2.min.js'
If you provide your own JS and would not like Django-Select2 to load any, change
this setting to a blank string like so::
SELECT2_JS = ''
.. tip:: Change this setting to a local asset in your development environment to
develop without an Internet connection.
"""
CSS = "django_select2/select2.js/select2.css"
"""
The URI for the Select2 CSS file. By default this points to a local copy linked
to the libjs-select2.js Debian package, to be served via staticfiles.
If you want to select the version of the library used, or want to serve it from
the local 'static' resources, add a line to your settings.py like so::
SELECT2_CSS = 'assets/css/select2.css'
If you want to add more css (usually used in select2 themes), add a line
in settings.py like this::
SELECT2_CSS = [
'assets/css/select2.css',
'assets/css/select2-theme.css',
]
If you provide your own CSS and would not like Django-Select2 to load any, change
this setting to a blank string like so::
SELECT2_CSS = ''
.. tip:: Change this setting to a local asset in your development environment to
develop without an Internet connection.
"""
THEME = "default"
"""
Select2 supports custom themes using the theme option so you can style Select2
to match the rest of your application.
.. tip:: When using other themes, you may need use select2 css and theme css.
"""
I18N_PATH = "django_select2/select2.js/i18n"
"""
The base URI for the Select2 i18n files. By default this points to a local copy linked
to the libjs-select2.js Debian package, to be served via staticfiles.
If you want to select the version of the I18N library used, or want to serve it from
the local 'static' resources, add a line to your settings.py like so::
SELECT2_I18N_PATH = 'assets/js/i18n'
.. tip:: Change this setting to a local asset in your development environment to
develop without an Internet connection.
"""
I18N_AVAILABLE_LANGUAGES = [
"ar",
"az",
"bg",
"ca",
"cs",
"da",
"de",
"el",
"en",
"es",
"et",
"eu",
"fa",
"fi",
"fr",
"gl",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"ja",
"km",
"ko",
"lt",
"lv",
"mk",
"ms",
"nb",
"nl",
"pl",
"pt-BR",
"pt",
"ro",
"ru",
"sk",
"sr-Cyrl",
"sr",
"sv",
"th",
"tr",
"uk",
"vi",
"zh-CN",
"zh-TW",
]
"""
List of available translations.
List of ISO 639-1 language codes that are supported by Select2.
If currently set language code (e.g. using the HTTP ``Accept-Language`` header)
is in this list, Django-Select2 will use the language code to create load
the proper translation.
The full path for the language file consists of::
from django.utils import translations
full_path = "{i18n_path}/{language_code}.js".format(
i18n_path=settings.DJANGO_SELECT2_I18N,
language_code=translations.get_language(),
)
``settings.DJANGO_SELECT2_I18N`` refers to :attr:`.I18N_PATH`.
"""
class Meta:
"""Prefix for all Django-Select2 settings."""
prefix = "SELECT2"
|
