Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
dj-kaos-utils / forms / fields.py
Size: Mime:
from __future__ import annotations

from django import forms
from django.utils.html import format_html_join, format_html


class DataListTextWidget(forms.TextInput):
    """
    A Django form widget that renders a text input with a datalist populated with options from a given list.

    Example:
        >>> class MyForm(forms.Form):
        >>>     my_field = forms.CharField(widget=DataListTextWidget(datalist=['option1', 'option2', 'option3']))
    """

    def __init__(self, datalist, name, *args, **kwargs):
        """
        Initialize the widget with the list of options and the name of the datalist.

        :param datalist: list of options for the datalist
        :type datalist: list
        :param name: name of the datalist
        :type name: str
        """

        super(DataListTextWidget, self).__init__(*args, **kwargs)
        self._name = name
        self._list = datalist
        self.attrs.update({'list': f'list__{name}'})

    def render(self, name, value, attrs=None, renderer=None):
        """
        Render the text input and datalist.
        """

        datalist_html = format_html('<datalist id="list__{name}">{options}</datalist>',
                                    name=self._name,
                                    options=format_html_join('', '<option value="{}">', self._list))

        return super(DataListTextWidget, self).render(name, value, attrs=attrs) + datalist_html


__all__ = (
    'DataListTextWidget',
)