html_compose.attributes.img_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import StrLike
  4
  5
  6class ImgAttrs:
  7    """
  8    This module contains functions for attributes in the 'img' element.
  9    Which is inherited by a class so we can generate type hints
 10    """
 11
 12    @staticmethod
 13    def alt(value: StrLike) -> BaseAttribute:
 14        """
 15        "img" attribute: alt
 16        Replacement text for use when images are not available
 17
 18        Args:
 19            value:
 20                Text*
 21
 22        Returns:
 23            An alt attribute to be added to your element
 24
 25        """
 26
 27        return BaseAttribute("alt", value)
 28
 29    @staticmethod
 30    def crossorigin(
 31        value: Literal["anonymous", "use-credentials"],
 32    ) -> BaseAttribute:
 33        """
 34        "img" attribute: crossorigin
 35        How the element handles crossorigin requests
 36
 37        Args:
 38            value:
 39                ['anonymous', 'use-credentials']
 40
 41        Returns:
 42            An crossorigin attribute to be added to your element
 43
 44        """
 45
 46        return BaseAttribute("crossorigin", value)
 47
 48    @staticmethod
 49    def decoding(value: Literal["sync", "async", "auto"]) -> BaseAttribute:
 50        """
 51        "img" attribute: decoding
 52        Decoding hint to use when processing this image for presentation
 53
 54        Args:
 55            value:
 56                ['sync', 'async', 'auto']
 57
 58        Returns:
 59            An decoding attribute to be added to your element
 60
 61        """
 62
 63        return BaseAttribute("decoding", value)
 64
 65    @staticmethod
 66    def fetchpriority(value: Literal["auto", "high", "low"]) -> BaseAttribute:
 67        """
 68        "img" attribute: fetchpriority
 69        Sets the priority for fetches initiated by the element
 70
 71        Args:
 72            value:
 73                ['auto', 'high', 'low']
 74
 75        Returns:
 76            An fetchpriority attribute to be added to your element
 77
 78        """
 79
 80        return BaseAttribute("fetchpriority", value)
 81
 82    @staticmethod
 83    def height(value: int) -> BaseAttribute:
 84        """
 85        "img" attribute: height
 86        Vertical dimension
 87
 88        Args:
 89            value:
 90                Valid non-negative integer
 91
 92        Returns:
 93            An height attribute to be added to your element
 94
 95        """
 96
 97        return BaseAttribute("height", value)
 98
 99    @staticmethod
100    def ismap(value: bool) -> BaseAttribute:
101        """
102        "img" attribute: ismap
103        Whether the image is a server-side image map
104
105        Args:
106            value:
107                Boolean attribute
108
109        Returns:
110            An ismap attribute to be added to your element
111
112        """
113
114        return BaseAttribute("ismap", value)
115
116    @staticmethod
117    def loading(value: Literal["lazy", "eager"]) -> BaseAttribute:
118        """
119        "img" attribute: loading
120        Used when determining loading deferral
121
122        Args:
123            value:
124                ['lazy', 'eager']
125
126        Returns:
127            An loading attribute to be added to your element
128
129        """
130
131        return BaseAttribute("loading", value)
132
133    @staticmethod
134    def referrerpolicy(value) -> BaseAttribute:
135        """
136        "img" attribute: referrerpolicy
137        Referrer policy for fetches initiated by the element
138
139        Args:
140            value:
141                Referrer policy
142
143        Returns:
144            An referrerpolicy attribute to be added to your element
145
146        """
147
148        return BaseAttribute("referrerpolicy", value)
149
150    @staticmethod
151    def sizes(value) -> BaseAttribute:
152        """
153        "img" attribute: sizes
154        Image sizes for different page layouts
155
156        Args:
157            value:
158                Valid source size list
159
160        Returns:
161            An sizes attribute to be added to your element
162
163        """
164
165        return BaseAttribute("sizes", value)
166
167    @staticmethod
168    def src(value) -> BaseAttribute:
169        """
170        "img" attribute: src
171        Address of the resource
172
173        Args:
174            value:
175                Valid non-empty URL potentially surrounded by spaces
176
177        Returns:
178            An src attribute to be added to your element
179
180        """
181
182        return BaseAttribute("src", value)
183
184    @staticmethod
185    def srcset(value) -> BaseAttribute:
186        """
187        "img" attribute: srcset
188        Images to use in different situations, e.g., high-resolution displays, small monitors, etc.
189
190        Args:
191            value:
192                Comma-separated list of image candidate strings
193
194        Returns:
195            An srcset attribute to be added to your element
196
197        """
198
199        return BaseAttribute("srcset", value)
200
201    @staticmethod
202    def usemap(value) -> BaseAttribute:
203        """
204        "img" attribute: usemap
205        Name of image map to use
206
207        Args:
208            value:
209                Valid hash-name reference*
210
211        Returns:
212            An usemap attribute to be added to your element
213
214        """
215
216        return BaseAttribute("usemap", value)
217
218    @staticmethod
219    def width(value: int) -> BaseAttribute:
220        """
221        "img" attribute: width
222        Horizontal dimension
223
224        Args:
225            value:
226                Valid non-negative integer
227
228        Returns:
229            An width attribute to be added to your element
230
231        """
232
233        return BaseAttribute("width", value)