html_compose.attributes.select_attrs

  1from . import BaseAttribute
  2from ..base_types import StrLike
  3
  4
  5class SelectAttrs:
  6    """
  7    This module contains functions for attributes in the 'select' element.
  8    Which is inherited by a class so we can generate type hints
  9    """
 10
 11    @staticmethod
 12    def autocomplete(value) -> BaseAttribute:
 13        """
 14        "select" attribute: autocomplete
 15        Hint for form autofill feature
 16
 17        Args:
 18            value:
 19                Autofill field name and related tokens*
 20
 21        Returns:
 22            An autocomplete attribute to be added to your element
 23
 24        """
 25
 26        return BaseAttribute("autocomplete", value)
 27
 28    @staticmethod
 29    def disabled(value: bool) -> BaseAttribute:
 30        """
 31        "select" attribute: disabled
 32        Whether the form control is disabled
 33
 34        Args:
 35            value:
 36                Boolean attribute
 37
 38        Returns:
 39            An disabled attribute to be added to your element
 40
 41        """
 42
 43        return BaseAttribute("disabled", value)
 44
 45    @staticmethod
 46    def form(value) -> BaseAttribute:
 47        """
 48        "select" attribute: form
 49        Associates the element with a form element
 50
 51        Args:
 52            value:
 53                ID*
 54
 55        Returns:
 56            An form attribute to be added to your element
 57
 58        """
 59
 60        return BaseAttribute("form", value)
 61
 62    @staticmethod
 63    def multiple(value: bool) -> BaseAttribute:
 64        """
 65        "select" attribute: multiple
 66        Whether to allow multiple values
 67
 68        Args:
 69            value:
 70                Boolean attribute
 71
 72        Returns:
 73            An multiple attribute to be added to your element
 74
 75        """
 76
 77        return BaseAttribute("multiple", value)
 78
 79    @staticmethod
 80    def name(value: StrLike) -> BaseAttribute:
 81        """
 82        "select" attribute: name
 83        Name of the element to use for form submission and in the form.elements API
 84
 85        Args:
 86            value:
 87                Text*
 88
 89        Returns:
 90            An name attribute to be added to your element
 91
 92        """
 93
 94        return BaseAttribute("name", value)
 95
 96    @staticmethod
 97    def required(value: bool) -> BaseAttribute:
 98        """
 99        "select" attribute: required
100        Whether the control is required for form submission
101
102        Args:
103            value:
104                Boolean attribute
105
106        Returns:
107            An required attribute to be added to your element
108
109        """
110
111        return BaseAttribute("required", value)
112
113    @staticmethod
114    def size(value) -> BaseAttribute:
115        """
116        "select" attribute: size
117        Size of the control
118
119        Args:
120            value:
121                Valid non-negative integer greater than zero
122
123        Returns:
124            An size attribute to be added to your element
125
126        """
127
128        return BaseAttribute("size", value)