zostera / django-bootstrap5 / 38130387761

100%

push

github

Add show_label to bootstrap_label (#879)

* Add show_label to bootstrap_label

bootstrap_field takes show_label, but bootstrap_label had no equivalent,
so a hand-rolled label needed label_class="visually-hidden" to be
screen-reader-only, and there was no way to render nothing at all.

render_label now takes show_label with the same values as the field tag:
True, False or 'visually-hidden' to append visually-hidden to the label's
CSS classes, and 'skip' to render nothing. label_class is kept rather
than replaced, so a caller's own class survives.

The field renderer resolves the label class and the 'skip' case itself
and does not pass show_label on, so bootstrap_field, bootstrap_form and
bootstrap_formset render exactly as before.

Fixes #526.

* Honour show_label='visually-hidden' on bootstrap_field

get_label_class tested show_label for truthiness, so only False added
the visually-hidden class. The string 'visually-hidden' is truthy and
fell through to the visible-label branch, although both tags document
the two values as equivalent.

Nothing covered that value for either tag, so the field tests gain a
case for it alongside the existing show_label ones.

* Drop form-label from a visually hidden bootstrap_label

Bootstrap's own docs render every visually hidden label with
class="visually-hidden" alone, and the field path in renderers.py
already replaces form-label rather than adding to it, including in its
is_inline branch. bootstrap_label was the odd one out, emitting
form-label visually-hidden, so the same show_label value meant two
different things depending on which tag you reached it through.

A label_class passed by the caller is still kept, in both paths, and
show_label=False on bootstrap_field is untouched.

---------

Co-authored-by: Dylan Verheul <dylan@dyve.net>

222 of 222 branches covered (100.0%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 2 files covered. (100.0%)

712 of 712 relevant lines covered (100.0%)

15.0 hits per line