Skip to content

Commit 7839deb

Browse files
committed
improved documentation and functionality for legacy class Row() in form rules
1 parent b4d40b8 commit 7839deb

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

flask_admin/form/rules.py

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -360,13 +360,39 @@ def __init__(self, rules, header=None, separator=''):
360360

361361

362362
class Row(NestedRule):
363-
def __init__(self, *columns, **kw):
364-
super(Row, self).__init__()
365-
self.row_classes = kw.get("row_classes", "form-row")
366-
self.col_classes = kw.get("col_classes", "col")
367-
self.rules = columns
363+
"""
364+
Bootstrap grid "row" div with automatic Bootstrap columns
365+
"""
366+
def __init__(self, columns=[], separator="", row_classes="form-row", col_classes="col"):
367+
"""
368+
Constructor
369+
370+
:param columns:
371+
Child rule list of column names.
372+
:param separator:
373+
Default separator between rules when rendering them.
374+
:param row_classes:
375+
Space-separated classes to use for the Bootstrap row (e.g. "form-row justify-content-center").
376+
Default "form-row"
377+
:param col_classes:
378+
Space-separated classes to use for the Bootstrap columns (e.g. "col-md-6").
379+
Default "col"
380+
"""
381+
super(Row, self).__init__(rules=columns, separator=separator)
382+
self.row_classes = row_classes
383+
self.col_classes = col_classes
368384

369385
def __call__(self, form, form_opts=None, field_args={}):
386+
"""
387+
Render all children when called in the Jinja template.
388+
389+
:param form:
390+
Form object
391+
:param form_opts:
392+
Form options
393+
:param field_args:
394+
Optional arguments that should be passed to template or the field
395+
"""
370396
cols = []
371397
for col in self.rules:
372398
if col.visible_fields:

0 commit comments

Comments
 (0)