html_compose.attributes.iframe_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3from ..base_types import Resolvable
  4
  5
  6class IframeAttrs:
  7    """
  8    This module contains functions for attributes in the 'iframe' element.
  9    Which is inherited by a class so we can generate type hints
 10    """
 11
 12    @staticmethod
 13    def allow(value) -> BaseAttribute:
 14        """
 15        "iframe" attribute: allow
 16        Permissions policy to be applied to the iframe's contents
 17
 18        Args:
 19            value:
 20                Serialized permissions policy
 21
 22        Returns:
 23            An allow attribute to be added to your element
 24
 25        """
 26
 27        return BaseAttribute("allow", value)
 28
 29    @staticmethod
 30    def allowfullscreen(value: bool) -> BaseAttribute:
 31        """
 32        "iframe" attribute: allowfullscreen
 33        Whether to allow the iframe's contents to use requestFullscreen()
 34
 35        Args:
 36            value:
 37                Boolean attribute
 38
 39        Returns:
 40            An allowfullscreen attribute to be added to your element
 41
 42        """
 43
 44        return BaseAttribute("allowfullscreen", value)
 45
 46    @staticmethod
 47    def height(value: int) -> BaseAttribute:
 48        """
 49        "iframe" attribute: height
 50        Vertical dimension
 51
 52        Args:
 53            value:
 54                Valid non-negative integer
 55
 56        Returns:
 57            An height attribute to be added to your element
 58
 59        """
 60
 61        return BaseAttribute("height", value)
 62
 63    @staticmethod
 64    def loading(value: Literal["lazy", "eager"]) -> BaseAttribute:
 65        """
 66        "iframe" attribute: loading
 67        Used when determining loading deferral
 68
 69        Args:
 70            value:
 71                ['lazy', 'eager']
 72
 73        Returns:
 74            An loading attribute to be added to your element
 75
 76        """
 77
 78        return BaseAttribute("loading", value)
 79
 80    @staticmethod
 81    def name(value) -> BaseAttribute:
 82        """
 83        "iframe" attribute: name
 84        Name of content navigable
 85
 86        Args:
 87            value:
 88                Valid navigable target name or keyword
 89
 90        Returns:
 91            An name attribute to be added to your element
 92
 93        """
 94
 95        return BaseAttribute("name", value)
 96
 97    @staticmethod
 98    def referrerpolicy(value) -> BaseAttribute:
 99        """
100        "iframe" 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 sandbox(value: Resolvable) -> BaseAttribute:
116        """
117        "iframe" attribute: sandbox
118        Security rules for nested content
119
120        Args:
121            value:
122                Unordered set of unique space-separated tokens, ASCII case-insensitive, consisting of "allow-downloads" "allow-forms" "allow-modals" "allow-orientation-lock" "allow-pointer-lock" "allow-popups" "allow-popups-to-escape-sandbox" "allow-presentation" "allow-same-origin" "allow-scripts" "allow-top-navigation" "allow-top-navigation-by-user-activation" "allow-top-navigation-to-custom-protocols"
123
124        Returns:
125            An sandbox attribute to be added to your element
126
127        """
128
129        return BaseAttribute("sandbox", value)
130
131    @staticmethod
132    def src(value) -> BaseAttribute:
133        """
134        "iframe" attribute: src
135        Address of the resource
136
137        Args:
138            value:
139                Valid non-empty URL potentially surrounded by spaces
140
141        Returns:
142            An src attribute to be added to your element
143
144        """
145
146        return BaseAttribute("src", value)
147
148    @staticmethod
149    def srcdoc(value) -> BaseAttribute:
150        """
151        "iframe" attribute: srcdoc
152        A document to render in the iframe
153
154        Args:
155            value:
156                The source of an iframe srcdoc document*
157
158        Returns:
159            An srcdoc attribute to be added to your element
160
161        """
162
163        return BaseAttribute("srcdoc", value)
164
165    @staticmethod
166    def width(value: int) -> BaseAttribute:
167        """
168        "iframe" attribute: width
169        Horizontal dimension
170
171        Args:
172            value:
173                Valid non-negative integer
174
175        Returns:
176            An width attribute to be added to your element
177
178        """
179
180        return BaseAttribute("width", value)