html_compose.attributes.button_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import StrLike
  4
  5
  6class ButtonAttrs:
  7    """
  8    This module contains functions for attributes in the 'button' element.
  9    Which is inherited by a class so we can generate type hints
 10    """
 11
 12    @staticmethod
 13    def disabled(value: bool) -> BaseAttribute:
 14        """
 15        "button" attribute: disabled
 16        Whether the form control is disabled
 17
 18        Args:
 19            value:
 20                Boolean attribute
 21
 22        Returns:
 23            An disabled attribute to be added to your element
 24
 25        """
 26
 27        return BaseAttribute("disabled", value)
 28
 29    @staticmethod
 30    def form(value) -> BaseAttribute:
 31        """
 32        "button" attribute: form
 33        Associates the element with a form element
 34
 35        Args:
 36            value:
 37                ID*
 38
 39        Returns:
 40            An form attribute to be added to your element
 41
 42        """
 43
 44        return BaseAttribute("form", value)
 45
 46    @staticmethod
 47    def formaction(value) -> BaseAttribute:
 48        """
 49        "button" attribute: formaction
 50        URL to use for form submission
 51
 52        Args:
 53            value:
 54                Valid non-empty URL potentially surrounded by spaces
 55
 56        Returns:
 57            An formaction attribute to be added to your element
 58
 59        """
 60
 61        return BaseAttribute("formaction", value)
 62
 63    @staticmethod
 64    def formenctype(
 65        value: Literal[
 66            "application/x-www-form-urlencoded",
 67            "multipart/form-data",
 68            "text/plain",
 69        ],
 70    ) -> BaseAttribute:
 71        """
 72        "button" attribute: formenctype
 73        Entry list encoding type to use for form submission
 74
 75        Args:
 76            value:
 77                ['application/x-www-form-urlencoded', 'multipart/form-data', 'text/plain']
 78
 79        Returns:
 80            An formenctype attribute to be added to your element
 81
 82        """
 83
 84        return BaseAttribute("formenctype", value)
 85
 86    @staticmethod
 87    def formmethod(value: Literal["GET", "POST", "dialog"]) -> BaseAttribute:
 88        """
 89        "button" attribute: formmethod
 90        Variant to use for form submission
 91
 92        Args:
 93            value:
 94                ['GET', 'POST', 'dialog']
 95
 96        Returns:
 97            An formmethod attribute to be added to your element
 98
 99        """
100
101        return BaseAttribute("formmethod", value)
102
103    @staticmethod
104    def formnovalidate(value: bool) -> BaseAttribute:
105        """
106        "button" attribute: formnovalidate
107        Bypass form control validation for form submission
108
109        Args:
110            value:
111                Boolean attribute
112
113        Returns:
114            An formnovalidate attribute to be added to your element
115
116        """
117
118        return BaseAttribute("formnovalidate", value)
119
120    @staticmethod
121    def formtarget(value) -> BaseAttribute:
122        """
123        "button" attribute: formtarget
124        Navigable for form submission
125
126        Args:
127            value:
128                Valid navigable target name or keyword
129
130        Returns:
131            An formtarget attribute to be added to your element
132
133        """
134
135        return BaseAttribute("formtarget", value)
136
137    @staticmethod
138    def name(value: StrLike) -> BaseAttribute:
139        """
140        "button" attribute: name
141        Name of the element to use for form submission and in the form.elements API
142
143        Args:
144            value:
145                Text*
146
147        Returns:
148            An name attribute to be added to your element
149
150        """
151
152        return BaseAttribute("name", value)
153
154    @staticmethod
155    def popovertarget(value) -> BaseAttribute:
156        """
157        "button" attribute: popovertarget
158        Targets a popover element to toggle, show, or hide
159
160        Args:
161            value:
162                ID*
163
164        Returns:
165            An popovertarget attribute to be added to your element
166
167        """
168
169        return BaseAttribute("popovertarget", value)
170
171    @staticmethod
172    def popovertargetaction(
173        value: Literal["toggle", "show", "hide"],
174    ) -> BaseAttribute:
175        """
176        "button" attribute: popovertargetaction
177        Indicates whether a targeted popover element is to be toggled, shown, or hidden
178
179        Args:
180            value:
181                ['toggle', 'show', 'hide']
182
183        Returns:
184            An popovertargetaction attribute to be added to your element
185
186        """
187
188        return BaseAttribute("popovertargetaction", value)
189
190    @staticmethod
191    def type(value: Literal["submit", "reset", "button"]) -> BaseAttribute:
192        """
193        "button" attribute: type
194        Type of button
195
196        Args:
197            value:
198                ['submit', 'reset', 'button']
199
200        Returns:
201            An type attribute to be added to your element
202
203        """
204
205        return BaseAttribute("type", value)
206
207    @staticmethod
208    def value(value: StrLike) -> BaseAttribute:
209        """
210        "button" attribute: value
211        Value to be used for form submission
212
213        Args:
214            value:
215                Text
216
217        Returns:
218            An value attribute to be added to your element
219
220        """
221
222        return BaseAttribute("value", value)