html_compose.attributes.script_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import Resolvable, StrLike
  4
  5
  6class ScriptAttrs:
  7    """
  8    This module contains functions for attributes in the 'script' element.
  9    Which is inherited by a class so we can generate type hints
 10    """
 11
 12    @staticmethod
 13    def async_(value: bool) -> BaseAttribute:
 14        """
 15        "script" attribute: async
 16        Execute script when available, without blocking while fetching
 17
 18        Args:
 19            value:
 20                Boolean attribute
 21
 22        Returns:
 23            An async attribute to be added to your element
 24
 25        """
 26
 27        return BaseAttribute("async", value)
 28
 29    @staticmethod
 30    def blocking(value: Resolvable) -> BaseAttribute:
 31        """
 32        "script" attribute: blocking
 33        Whether the element is potentially render-blocking
 34
 35        Args:
 36            value:
 37                Unordered set of unique space-separated tokens*
 38
 39        Returns:
 40            An blocking attribute to be added to your element
 41
 42        """
 43
 44        return BaseAttribute("blocking", value)
 45
 46    @staticmethod
 47    def crossorigin(
 48        value: Literal["anonymous", "use-credentials"],
 49    ) -> BaseAttribute:
 50        """
 51        "script" attribute: crossorigin
 52        How the element handles crossorigin requests
 53
 54        Args:
 55            value:
 56                ['anonymous', 'use-credentials']
 57
 58        Returns:
 59            An crossorigin attribute to be added to your element
 60
 61        """
 62
 63        return BaseAttribute("crossorigin", value)
 64
 65    @staticmethod
 66    def defer(value: bool) -> BaseAttribute:
 67        """
 68        "script" attribute: defer
 69        Defer script execution
 70
 71        Args:
 72            value:
 73                Boolean attribute
 74
 75        Returns:
 76            An defer attribute to be added to your element
 77
 78        """
 79
 80        return BaseAttribute("defer", value)
 81
 82    @staticmethod
 83    def fetchpriority(value: Literal["auto", "high", "low"]) -> BaseAttribute:
 84        """
 85        "script" attribute: fetchpriority
 86        Sets the priority for fetches initiated by the element
 87
 88        Args:
 89            value:
 90                ['auto', 'high', 'low']
 91
 92        Returns:
 93            An fetchpriority attribute to be added to your element
 94
 95        """
 96
 97        return BaseAttribute("fetchpriority", value)
 98
 99    @staticmethod
100    def integrity(value: StrLike) -> BaseAttribute:
101        """
102        "script" attribute: integrity
103        Integrity metadata used in Subresource Integrity checks [SRI]
104
105        Args:
106            value:
107                Text
108
109        Returns:
110            An integrity attribute to be added to your element
111
112        """
113
114        return BaseAttribute("integrity", value)
115
116    @staticmethod
117    def nomodule(value: bool) -> BaseAttribute:
118        """
119        "script" attribute: nomodule
120        Prevents execution in user agents that support module scripts
121
122        Args:
123            value:
124                Boolean attribute
125
126        Returns:
127            An nomodule attribute to be added to your element
128
129        """
130
131        return BaseAttribute("nomodule", value)
132
133    @staticmethod
134    def referrerpolicy(value) -> BaseAttribute:
135        """
136        "script" 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 src(value) -> BaseAttribute:
152        """
153        "script" attribute: src
154        Address of the resource
155
156        Args:
157            value:
158                Valid non-empty URL potentially surrounded by spaces
159
160        Returns:
161            An src attribute to be added to your element
162
163        """
164
165        return BaseAttribute("src", value)
166
167    @staticmethod
168    def type(value) -> BaseAttribute:
169        """
170        "script" attribute: type
171        Type of script
172
173        Args:
174            value:
175                "module"; a valid MIME type string that is not a JavaScript MIME type essence match
176
177        Returns:
178            An type attribute to be added to your element
179
180        """
181
182        return BaseAttribute("type", value)