html_compose.attributes.a_attrs

  1from . import BaseAttribute
  2from ..base_types import Resolvable, StrLike
  3
  4
  5class AnchorAttrs:
  6    """
  7    This module contains functions for attributes in the 'a' element.
  8    Which is inherited by a class so we can generate type hints
  9    """
 10
 11    @staticmethod
 12    def download(value: StrLike) -> BaseAttribute:
 13        """
 14        "a" attribute: download
 15        Whether to download the resource instead of navigating to it, and its filename if so
 16
 17        Args:
 18            value:
 19                Text
 20
 21        Returns:
 22            An download attribute to be added to your element
 23
 24        """
 25
 26        return BaseAttribute("download", value)
 27
 28    @staticmethod
 29    def href(value) -> BaseAttribute:
 30        """
 31        "a" attribute: href
 32        Address of the hyperlink
 33
 34        Args:
 35            value:
 36                Valid URL potentially surrounded by spaces
 37
 38        Returns:
 39            An href attribute to be added to your element
 40
 41        """
 42
 43        return BaseAttribute("href", value)
 44
 45    @staticmethod
 46    def hreflang(value) -> BaseAttribute:
 47        """
 48        "a" attribute: hreflang
 49        Language of the linked resource
 50
 51        Args:
 52            value:
 53                Valid BCP 47 language tag
 54
 55        Returns:
 56            An hreflang attribute to be added to your element
 57
 58        """
 59
 60        return BaseAttribute("hreflang", value)
 61
 62    @staticmethod
 63    def ping(value: Resolvable) -> BaseAttribute:
 64        """
 65        "a" attribute: ping
 66        URLs to ping
 67
 68        Args:
 69            value:
 70                Set of space-separated tokens consisting of valid non-empty URLs
 71
 72        Returns:
 73            An ping attribute to be added to your element
 74
 75        """
 76
 77        return BaseAttribute("ping", value)
 78
 79    @staticmethod
 80    def referrerpolicy(value) -> BaseAttribute:
 81        """
 82        "a" attribute: referrerpolicy
 83        Referrer policy for fetches initiated by the element
 84
 85        Args:
 86            value:
 87                Referrer policy
 88
 89        Returns:
 90            An referrerpolicy attribute to be added to your element
 91
 92        """
 93
 94        return BaseAttribute("referrerpolicy", value)
 95
 96    @staticmethod
 97    def rel(value: Resolvable) -> BaseAttribute:
 98        """
 99        "a" attribute: rel
100        Relationship between the location in the document containing the hyperlink and the destination resource
101
102        Args:
103            value:
104                Unordered set of unique space-separated tokens*
105
106        Returns:
107            An rel attribute to be added to your element
108
109        """
110
111        return BaseAttribute("rel", value)
112
113    @staticmethod
114    def target(value) -> BaseAttribute:
115        """
116        "a" attribute: target
117        Navigable for hyperlink navigation
118
119        Args:
120            value:
121                Valid navigable target name or keyword
122
123        Returns:
124            An target attribute to be added to your element
125
126        """
127
128        return BaseAttribute("target", value)
129
130    @staticmethod
131    def type(value) -> BaseAttribute:
132        """
133        "a" attribute: type
134        Hint for the type of the referenced resource
135
136        Args:
137            value:
138                Valid MIME type string
139
140        Returns:
141            An type attribute to be added to your element
142
143        """
144
145        return BaseAttribute("type", value)