HTMLIFrameElement

The HTMLIFrameElement interface provides special properties and methods (beyond those of the HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of inline frame elements.

Instance properties

Inherits properties from its parent, HTMLElement.

• align Deprecated
  • : A string that specifies the alignment of the frame with respect to the surrounding context.
• allow
  • : A string that indicates the Permissions Policy specified for this <iframe>.
• allowFullscreen
  • : A boolean value indicating whether the inline frame is willing to be placed into full screen mode. See Using fullscreen mode for details.
• allowPaymentRequest Deprecated
  • : A boolean value indicating whether the Payment Request API may be invoked inside a cross-origin iframe.
• browsingTopics Deprecated
  • : A boolean property specifying that the selected topics for the current user should be sent with the request for the associated <iframe>’s source. This reflects the browsingtopics content attribute value.
• contentDocument Read only
  • : Returns a Document, the active document in the inline frame’s nested browsing context.
• contentWindow Read only
  • : Returns a WindowProxy, the window proxy for the nested browsing context.
• credentialless Experimental
  • : A boolean value indicating whether the <iframe> is credentialless, meaning that its content is loaded in a new, ephemeral context. This context does not have access to the parent context’s shared storage and credentials. In return, the Cross-Origin-Embedder-Policy (COEP) embedding rules can be lifted, so documents with COEP set can embed third-party documents that do not. See IFrame credentialless for a deeper explanation.
• csp Experimental
  • : Specifies the Content Security Policy that an embedded document must agree to enforce upon itself.
• featurePolicy Read only Experimental
  • : Returns the FeaturePolicy interface which provides a simple API for introspecting the Permissions Policies applied to a specific document.
• frameBorder Deprecated
  • : A string that indicates whether to create borders between frames.
• height
  • : A string that reflects the height HTML attribute, indicating the height of the frame.
• loading
  • : A string providing a hint to the browser that the iframe should be loaded immediately (eager) or on an as-needed basis (lazy). This reflects the loading HTML attribute.
• longDesc Deprecated
  • : A string that contains the URI of a long description of the frame.
• marginHeight Deprecated
  • : A string being the height of the frame margin.
• marginWidth Deprecated
  • : A string being the width of the frame margin.
• name
  • : A string that reflects the name HTML attribute, containing a name by which to refer to the frame.
• privateToken Experimental
  • : A string representation of an options object representing a private state token operation; this object has the same structure as the RequestInit dictionary’s privateToken property. Mirrors the content of the associated <iframe> element’s privateToken attribute.
• referrerPolicy
  • : A string that reflects the referrerPolicy HTML attribute indicating which referrer to use when fetching the linked resource.
• sandbox Read only
  • : Returns a DOMTokenList that reflects the sandbox HTML attribute, indicating extra restrictions on the behavior of the nested content.
• scrolling Deprecated
  • : A string that indicates whether the browser should provide scrollbars for the frame.
• src
  • : A string that reflects the src HTML attribute, containing the address of the content to be embedded. Note that programmatically removing an <iframe>’s src attribute (e.g., via removeAttribute()) causes about:blank to be loaded in the frame in Firefox (from version 65), Chromium-based browsers, and Safari/iOS.
• srcdoc
  • : A TrustedHTML or string that represents the HTML document loaded into the frame.
• width
  • : A string that reflects the width HTML attribute, indicating the width of the frame.

Instance methods

Also inherits methods from its parent interface, HTMLElement.

• getSVGDocument()
  • : Returns the embedded SVG as a Document.

Specifications

Browser compatibility

See also

• The HTML element implementing this interface: <iframe>