html_compose.attributes.form_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import StrLike
  4
  5
  6class FormAttrs:
  7    """
  8    This module contains functions for attributes in the 'form' element.
  9    Which is inherited by a class so we can generate type hints
 10    """
 11
 12    @staticmethod
 13    def accept_charset(value) -> BaseAttribute:
 14        """
 15        "form" attribute: accept-charset
 16        Character encodings to use for form submission
 17
 18        Args:
 19            value:
 20                ASCII case-insensitive match for "UTF-8"
 21
 22        Returns:
 23            An accept-charset attribute to be added to your element
 24
 25        """
 26
 27        return BaseAttribute("accept-charset", value)
 28
 29    @staticmethod
 30    def action(value) -> BaseAttribute:
 31        """
 32        "form" attribute: action
 33        URL to use for form submission
 34
 35        Args:
 36            value:
 37                Valid non-empty URL potentially surrounded by spaces
 38
 39        Returns:
 40            An action attribute to be added to your element
 41
 42        """
 43
 44        return BaseAttribute("action", value)
 45
 46    @staticmethod
 47    def autocomplete(value: Literal["on", "off"]) -> BaseAttribute:
 48        """
 49        "form" attribute: autocomplete
 50        Default setting for autofill feature for controls in the form
 51
 52        Args:
 53            value:
 54                ['on', 'off']
 55
 56        Returns:
 57            An autocomplete attribute to be added to your element
 58
 59        """
 60
 61        return BaseAttribute("autocomplete", value)
 62
 63    @staticmethod
 64    def enctype(
 65        value: Literal[
 66            "application/x-www-form-urlencoded",
 67            "multipart/form-data",
 68            "text/plain",
 69        ],
 70    ) -> BaseAttribute:
 71        """
 72        "form" attribute: enctype
 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 enctype attribute to be added to your element
 81
 82        """
 83
 84        return BaseAttribute("enctype", value)
 85
 86    @staticmethod
 87    def method(value: Literal["GET", "POST", "dialog"]) -> BaseAttribute:
 88        """
 89        "form" attribute: method
 90        Variant to use for form submission
 91
 92        Args:
 93            value:
 94                ['GET', 'POST', 'dialog']
 95
 96        Returns:
 97            An method attribute to be added to your element
 98
 99        """
100
101        return BaseAttribute("method", value)
102
103    @staticmethod
104    def name(value: StrLike) -> BaseAttribute:
105        """
106        "form" attribute: name
107        Name of form to use in the document.forms API
108
109        Args:
110            value:
111                Text*
112
113        Returns:
114            An name attribute to be added to your element
115
116        """
117
118        return BaseAttribute("name", value)
119
120    @staticmethod
121    def novalidate(value: bool) -> BaseAttribute:
122        """
123        "form" attribute: novalidate
124        Bypass form control validation for form submission
125
126        Args:
127            value:
128                Boolean attribute
129
130        Returns:
131            An novalidate attribute to be added to your element
132
133        """
134
135        return BaseAttribute("novalidate", value)
136
137    @staticmethod
138    def target(value) -> BaseAttribute:
139        """
140        "form" attribute: target
141        Navigable for form submission
142
143        Args:
144            value:
145                Valid navigable target name or keyword
146
147        Returns:
148            An target attribute to be added to your element
149
150        """
151
152        return BaseAttribute("target", value)