html_compose.attributes.area_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import Resolvable, StrLike
  4
  5
  6class AreaAttrs:
  7    """
  8    This module contains functions for attributes in the 'area' 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        "area" 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 coords(value) -> BaseAttribute:
 31        """
 32        "area" attribute: coords
 33        Coordinates for the shape to be created in an image map
 34
 35        Args:
 36            value:
 37                Valid list of floating-point numbers*
 38
 39        Returns:
 40            An coords attribute to be added to your element
 41
 42        """
 43
 44        return BaseAttribute("coords", value)
 45
 46    @staticmethod
 47    def download(value: StrLike) -> BaseAttribute:
 48        """
 49        "area" attribute: download
 50        Whether to download the resource instead of navigating to it, and its filename if so
 51
 52        Args:
 53            value:
 54                Text
 55
 56        Returns:
 57            An download attribute to be added to your element
 58
 59        """
 60
 61        return BaseAttribute("download", value)
 62
 63    @staticmethod
 64    def href(value) -> BaseAttribute:
 65        """
 66        "area" attribute: href
 67        Address of the hyperlink
 68
 69        Args:
 70            value:
 71                Valid URL potentially surrounded by spaces
 72
 73        Returns:
 74            An href attribute to be added to your element
 75
 76        """
 77
 78        return BaseAttribute("href", value)
 79
 80    @staticmethod
 81    def ping(value: Resolvable) -> BaseAttribute:
 82        """
 83        "area" attribute: ping
 84        URLs to ping
 85
 86        Args:
 87            value:
 88                Set of space-separated tokens consisting of valid non-empty URLs
 89
 90        Returns:
 91            An ping attribute to be added to your element
 92
 93        """
 94
 95        return BaseAttribute("ping", value)
 96
 97    @staticmethod
 98    def referrerpolicy(value) -> BaseAttribute:
 99        """
100        "area" attribute: referrerpolicy
101        Referrer policy for fetches initiated by the element
102
103        Args:
104            value:
105                Referrer policy
106
107        Returns:
108            An referrerpolicy attribute to be added to your element
109
110        """
111
112        return BaseAttribute("referrerpolicy", value)
113
114    @staticmethod
115    def rel(value: Resolvable) -> BaseAttribute:
116        """
117        "area" attribute: rel
118        Relationship between the location in the document containing the hyperlink and the destination resource
119
120        Args:
121            value:
122                Unordered set of unique space-separated tokens*
123
124        Returns:
125            An rel attribute to be added to your element
126
127        """
128
129        return BaseAttribute("rel", value)
130
131    @staticmethod
132    def shape(
133        value: Literal["circle", "default", "poly", "rect"],
134    ) -> BaseAttribute:
135        """
136        "area" attribute: shape
137        The kind of shape to be created in an image map
138
139        Args:
140            value:
141                ['circle', 'default', 'poly', 'rect']
142
143        Returns:
144            An shape attribute to be added to your element
145
146        """
147
148        return BaseAttribute("shape", value)
149
150    @staticmethod
151    def target(value) -> BaseAttribute:
152        """
153        "area" attribute: target
154        Navigable for hyperlink navigation
155
156        Args:
157            value:
158                Valid navigable target name or keyword
159
160        Returns:
161            An target attribute to be added to your element
162
163        """
164
165        return BaseAttribute("target", value)