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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
{# This file was part of Flask-Bootstrap and was modified under the terms of
its BSD License. Copyright (c) 2013, Marc Brinkmann. All rights reserved. #}
{% macro render_hidden_errors(form) %}
{%- if form.errors %}
{%- for fieldname, errors in form.errors.items() %}
{%- if bootstrap_is_hidden_field(form[fieldname]) %}
{%- for error in errors %}
<div class="d-block invalid-feedback">{{ error }}</div>
{%- endfor %}
{%- endif %}
{%- endfor %}
{%- endif %}
{%- endmacro %}
{% macro _hz_form_wrap(horizontal_columns, form_type, add_group=False, required=False) %}
{% if form_type == "horizontal" %}
{% if add_group %}
<div class="form-group row{% if required %} required{% endif %}">{% endif %}
<div class="offset-{{ horizontal_columns[0] }}-{{ horizontal_columns[1] }}
col-{{ horizontal_columns[0] }}-{{ horizontal_columns[2] }}
">
{% endif %}
{{ caller() }}
{% if form_type == "horizontal" %}
{% if add_group %}</div>{% endif %}
</div>
{% endif %}
{% endmacro %}
{% macro render_field(field,
form_type="basic",
horizontal_columns=('lg', 2, 10),
button_map={},
button_style='',
button_size='') %}
{# this is a workaround hack for the more straightforward-code of just passing required=required parameter. older versions of wtforms do not have
the necessary fix for required=False attributes, but will also not set the required flag in the first place. we skirt the issue using the code below #}
{% if field.flags.required and not required in kwargs %}
{% set kwargs = dict(required=True, **kwargs) %}
{% endif %}
{# combine render_kw class or class/class_ argument with Bootstrap classes #}
{% set render_kw_class = ' ' + field.render_kw.class if field.render_kw.class else '' %}
{% set class = kwargs.pop('class', '') or kwargs.pop('class_', '') %}
{% if class %}
{# override render_kw class when class/class_ presents as keyword argument #}
{% set render_kw_class = '' %}
{% set render_kw_class_ = '' %}
{% set class = ' ' + class %}
{% endif %}
{% set extra_classes = render_kw_class + class %}
{% if field.widget.input_type == 'checkbox' %}
{% set field_kwargs = kwargs %}
{% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %}
{% if field.type == 'SwitchField' %}
<div class="form-group custom-control custom-switch{% if form_type == "inline" %} form-check-inline{% endif %}">
{%- if field.errors %}
{{ field(class_="custom-control-input is-invalid%s" % extra_classes)|safe }}
{%- else -%}
{{ field(class_="custom-control-input%s" % extra_classes)|safe }}
{%- endif %}
{{ field.label(class="custom-control-label", for=field.id)|safe }}
{% else %}
<div class="form-group form-check{% if form_type == "inline" %} form-check-inline{% endif %}">
{%- if field.errors %}
{{ field(class="form-check-input is-invalid%s" % extra_classes, **field_kwargs)|safe }}
{%- else -%}
{{ field(class="form-check-input%s" % extra_classes, **field_kwargs)|safe }}
{%- endif %}
{{ field.label(class="form-check-label", for=field.id)|safe }}
{% endif %}
{%- if field.errors %}
{%- for error in field.errors %}
<div class="invalid-feedback d-block">{{ error }}</div>
{%- endfor %}
{%- elif field.description -%}
{% call _hz_form_wrap(horizontal_columns, form_type, required=required) %}
<small class="form-text text-muted">{{ field.description|safe }}</small>
{% endcall %}
{%- endif %}
</div>
{% endcall %}
{%- elif field.type == 'RadioField' -%}
{# note: A cleaner solution would be rendering depending on the widget,
this is just a hack for now, until I can think of something better #}
<div class="form-group {% if form_type == 'horizontal' %}row{% endif %}{% if required %} required{% endif %}">
{%- if form_type == "inline" %}
{{ field.label(class="sr-only")|safe }}
{% elif form_type == "horizontal" %}
{{ field.label(class="col-form-label" + (
" col-%s-%s" % horizontal_columns[0:2]))|safe }}
{%- else -%}
{{ field.label(class="form-control-label")|safe }}
{% endif %}
{% if form_type == 'horizontal' %}
<div class="col-{{ horizontal_columns[0] }}-{{ horizontal_columns[2] }}">
{% endif %}
{#% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %#}
{% for item in field -%}
<div class="form-check{% if form_type == "inline" %} form-check-inline{% endif %}">
{{ item(class="form-check-input")|safe }}
{{ item.label(class="form-check-label", for=item.id)|safe }}
</div>
{% endfor %}
{#% endcall %#}
{% if form_type == 'horizontal' %}
</div>
{% endif %}
{%- if field.errors %}
{%- for error in field.errors %}
<div class="invalid-feedback d-block">{{ error }}</div>
{%- endfor %}
{%- elif field.description -%}
<small class="form-text text-muted">{{ field.description|safe }}</small>
{%- endif %}
</div>
{%- elif field.type == 'SubmitField' -%}
{# deal with jinja scoping issues? #}
{% set field_kwargs = kwargs %}
{# note: same issue as above - should check widget, not field type #}
{% call _hz_form_wrap(horizontal_columns, form_type, True, required=required) %}
{% set default_button_style = button_style or config.BOOTSTRAP_BTN_STYLE %}
{% set default_button_size = button_size or config.BOOTSTRAP_BTN_SIZE %}
{{ field(class='btn btn-%s btn-%s%s' % (button_map.get(field.name, default_button_style), default_button_size, extra_classes), **field_kwargs) }}
{% endcall %}
{%- elif field.type in ['CSRFTokenField', 'HiddenField'] -%}
{{ field()|safe }}
{%- elif field.type in ['FormField', 'FieldList'] -%}
{# note: FormFields are tricky to get right and complex setups requiring
these are probably beyond the scope of what this macro tries to do.
the code below ensures that things don't break horribly if we run into
one, but does not try too hard to get things pretty. #}
<fieldset>
<legend>{{ field.label }}</legend>
{%- for subfield in field %}
{% if not bootstrap_is_hidden_field(subfield) -%}
{{ render_field(subfield,
form_type=form_type,
horizontal_columns=horizontal_columns,
button_map=button_map) }}
{%- endif %}
{%- endfor %}
</fieldset>
{% else -%}
<div class="form-group{%- if form_type == "horizontal" %} row{% endif -%}
{%- if field.flags.required %} required{% endif -%}">
{%- if form_type == "inline" %}
{{ field.label(class="sr-only")|safe }}
{% if field.type == 'FileField' %}
{% if field.errors %}
{{ field(class="form-control-file is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-file%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{%- elif field.type in ['DecimalRangeField', 'IntegerRangeField'] -%}
{% if field.errors %}
{{ field(class="form-control-range is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-range%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% else %}
{% if field.errors %}
{{ field(class="form-control mb-2 mr-sm-2 mb-sm-0 is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control mb-2 mr-sm-2 mb-sm-0%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% endif %}
{% elif form_type == "horizontal" %}
{{ field.label(class="col-form-label" + (" col-%s-%s" % horizontal_columns[0:2]))|safe }}
<div class="col-{{ horizontal_columns[0] }}-{{ horizontal_columns[2] }}">
{% if field.type == 'FileField' %}
{% if field.errors %}
{{ field(class="form-control-file is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-file%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{%- elif field.type in ['DecimalRangeField', 'IntegerRangeField'] -%}
{% if field.errors %}
{{ field(class="form-control-range is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-range%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% else %}
{% if field.errors %}
{{ field(class="form-control is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% endif %}
</div>
{%- if field.errors %}
{%- for error in field.errors %}
{% call _hz_form_wrap(horizontal_columns, form_type, required=required) %}
<div class="invalid-feedback d-block">{{ error }}</div>
{% endcall %}
{%- endfor %}
{%- elif field.description -%}
{% call _hz_form_wrap(horizontal_columns, form_type, required=required) %}
<small class="form-text text-muted">{{ field.description|safe }}</small>
{% endcall %}
{%- endif %}
{%- else -%}
{{ field.label(class="form-control-label")|safe }}
{% if field.type == 'FileField' %}
{% if field.errors %}
{{ field(class="form-control-file is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-file%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{%- elif field.type in ['DecimalRangeField', 'IntegerRangeField'] -%}
{% if field.errors %}
{{ field(class="form-control-range is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control-range%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% else %}
{% if field.errors %}
{{ field(class="form-control is-invalid%s" % extra_classes, **kwargs)|safe }}
{% else %}
{{ field(class="form-control%s" % extra_classes, **kwargs)|safe }}
{% endif %}
{% endif %}
{%- if field.errors %}
{%- for error in field.errors %}
<div class="invalid-feedback" style="display: block;">{{ error }}</div>
{%- endfor %}
{%- elif field.description -%}
<small class="form-text text-muted">{{ field.description|safe }}</small>
{%- endif %}
{%- endif %}
</div>
{% endif %}
{% endmacro %}
{# valid form types are "basic", "inline" and "horizontal" #}
{% macro render_form(form,
action="",
method="post",
extra_classes=None,
role="form",
form_type="basic",
horizontal_columns=('lg', 2, 10),
enctype=None,
button_map={},
button_style="",
button_size="",
id="",
novalidate=False,
render_kw={}) %}
{#-
action="" is what we want, from http://www.ietf.org/rfc/rfc2396.txt:
4.2. Same-document References
A URI reference that does not contain a URI is a reference to the
current document. In other words, an empty URI reference within a
document is interpreted as a reference to the start of that document,
and a reference containing only a fragment identifier is a reference
to the identified fragment of that document. Traversal of such a
reference should not result in an additional retrieval action.
However, if the URI reference occurs in a context that is always
intended to result in a new request, as in the case of HTML's FORM
element, then an empty URI reference represents the base URI of the
current document and should be replaced by that URI when transformed
into a request.
-#}
{#- if any file fields are inside the form and enctype is automatic, adjust
if file fields are found. could really use the equalto test of jinja2
here, but latter is not available until 2.8
warning: the code below is guaranteed to make you cry =(
#}
{%- set _enctype = [] %}
{%- if enctype is none -%}
{%- for field in form %}
{%- if field.type in ['FileField', 'MultipleFileField'] %}
{#- for loops come with a fairly watertight scope, so this list-hack is
used to be able to set values outside of it #}
{%- set _ = _enctype.append('multipart/form-data') -%}
{%- endif %}
{%- endfor %}
{%- else %}
{% set _ = _enctype.append(enctype) %}
{%- endif %}
<form{%- if action != None %} action="{{ action }}"{% endif -%}
{%- if id %} id="{{ id }}"{% endif -%}
{%- if method %} method="{{ method }}"{% endif %}
class="form
{%- if extra_classes %} {{ extra_classes }}{% endif -%}{%- if form_type == "inline" %} form-inline{% endif -%}"
{%- if _enctype[0] %} enctype="{{ _enctype[0] }}"{% endif -%}
{%- if role %} role="{{ role }}"{% endif -%}
{%- if novalidate %} novalidate{% endif -%}
{%- if render_kw %} {{ render_kw|xmlattr }}{% endif -%}>
{{ form.hidden_tag() }}
{{ render_hidden_errors(form) }}
{%- for field in form %}
{% if not bootstrap_is_hidden_field(field) -%}
{{ render_field(field,
form_type=form_type,
horizontal_columns=horizontal_columns,
button_map=button_map,
button_style=button_style,
button_size=button_size) }}
{%- endif %}
{%- endfor %}
</form>
{%- endmacro %}
{% macro render_form_row(fields,
row_class='form-row',
col_class_default='col',
col_map={},
button_map={},
button_style='',
button_size='',
form_type='basic',
horizontal_columns=('lg', 2, 10)) %}
<div class="{{ row_class }}">
{% for field in fields %}
{% if field.name in col_map %}
{% set col_class = col_map[field.name] %}
{% else %}
{% set col_class = col_class_default %}
{% endif %}
<div class="{{ col_class }}">
{{ render_field(field,
button_map=button_map,
button_style=button_style,
button_size=button_size,
form_type=form_type,
horizontal_columns=horizontal_columns) }}
</div>
{% endfor %}
</div>
{% endmacro %}
|
