Support for HTML-Templates

[jwaschkau]

Hello Joe,

First of all, many thanks for your library. With its ease of use, it has made many implementations much easier for me in the past.

I take issue #272 as an opportunity to suggest adding HTML template support to Django-Select2.

I have already successfully implemented these changes in my own project by adding the following function to the AutoResponseView:

def html_or_text(self, obj):
    label = self.widget.label_from_instance(obj)
    if hasattr(label, "__html__"):
        return {
            "text": "",
            "html": label,
            "id": obj.pk,
        }
    else:
        return {
            "text": label,
            "html": '',
            "id": obj.pk,
        }

Initialization in JavaScript works as follows:

    function template(data) {
        if ($(data.html).length === 0) {
            return data.text;
        }
        return $(data.html);
    }

myelement.djangoSelect2({
    templateResult: template,
    templateSelection: template
});

The result is the ability to render HTML within Select2 as soon as the text is declared safe by calling the function mark_safe(...).

This small change is certainly a good way to further improve the usability of the library.

For me, the question still arises whether the functionality is better realized in the AutoResponseView or as a mixin at the form level.

What are your thoughts?

Best regards