Represents the element - nested browsing context</p> <h2> <a id="included-modules" class="anchor" href="#included-modules"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Included Modules </h2> <ul class="other-types-list"> <li class="other-type"><a href="../../Components/Elements/UrlAttributeValidation.html">Components::Elements::UrlAttributeValidation</a></li> </ul> <h2> <a id="defined-in" class="anchor" href="#defined-in"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Defined in: </h2> <a href="https://github.com/amberframework/asset_pipeline/blob/v0.36.0/src/components/elements/embedded/media.cr#L136" target="_blank"> components/elements/embedded/media.cr </a> <br/> <h2> <a id="constructors" class="anchor" href="#constructors"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Constructors </h2> <ul class="list-summary"> <li class="entry-summary"> <a href="#new%28%2A%2Aattrs%29-class-method" class="signature"><strong>.new</strong>(**attrs)</a> <div class="summary"><p>SafeHTML v1 (docs/SAFE_HTML_V1.md §3.5, §3.7): <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> is an HTML-DOCUMENT-VALUED attribute, not a plain string one.</p></div> </li> <li class="entry-summary"> <a href="#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method" class="signature"><strong>.srcdoc</strong>(html : String, reason : String, **attrs) : Iframe</a> <div class="summary"><p>The typed, reasoned door for <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> — mirrors <code><a href="../../Components/Elements/Script.html#static%28js%3AString%2Creason%3AString%29%3AScript-class-method">Script.static(js, reason:)</a></code> / <code><a href="../../Components/SafeURL.html#unsafe%28url%3AString%2Creason%3AString%29%3ASafeURL-class-method">SafeURL.unsafe(url, reason:)</a></code>.</p></div> </li> </ul> <h2> <a id="instance-method-summary" class="anchor" href="#instance-method-summary"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Instance Method Summary </h2> <ul class="list-summary"> <li class="entry-summary"> <a href="#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method" class="signature"><strong>#set_attribute</strong>(name : String, value : String | Nil) : <span class="k">self</span></a> <div class="summary"><p>SafeHTML v1 (docs/SAFE_HTML_V1.md §3.5): reject a bare-<code>String</code> <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> here — this is the chokepoint both the constructor-kwarg path (<code>HTMLElement#initialize</code> calls <code><a href="../../Components/Elements/Iframe.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method">#set_attribute</a></code> once per kwarg) and the direct <code><a href="../../Components/Elements/Iframe.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method">#set_attribute</a></code> path funnel through, so one check closes both, matching how <code><a href="../../Components/Elements/UrlAttributeValidation.html">UrlAttributeValidation</a></code> closes <code>src</code>/<code>href</code> for the very same two paths.</p></div> </li> <li class="entry-summary"> <a href="#set_srcdoc%28html%3AString%2Creason%3AString%29%3Aself-instance-method" class="signature"><strong>#set_srcdoc</strong>(html : String, reason : String) : <span class="k">self</span></a> <div class="summary"><p>The typed, reasoned door for setting <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> on an already-built <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> — the shape most call sites need (an <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> constructed first via ordinary kwargs, <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> attached after), mirroring the already-existing instance-level typed setters <code>#set_safe_url_attribute</code> / <code>#set_safe_style</code>.</p></div> </li> </ul> <div class="methods-inherited"> <h3>Instance methods inherited from module <code><a href="../../Components/Elements/UrlAttributeValidation.html">Components::Elements::UrlAttributeValidation</a></code></h3> <a href="../../Components/Elements/UrlAttributeValidation.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method" class="tooltip"> <span>set_attribute(name : String, value : String | Nil) : <span class="k">self</span></span> set_attribute</a> <h3>Instance methods inherited from class <code><a href="../../Components/Elements/ContainerElement.html">Components::Elements::ContainerElement</a></code></h3> <a href="../../Components/Elements/ContainerElement.html#%3C%3C%28child%3AContainerElement%29%3AContainerElement-instance-method" class="tooltip"> <span><<(child : ContainerElement) : ContainerElement<br/><<(child : VoidElement | String | RawHTML) : <span class="k">self</span></span> <<</a>, <a href="../../Components/Elements/ContainerElement.html#add_child%28child%3AHTMLElement%7CString%7CRawHTML%29%3Aself-instance-method" class="tooltip"> <span>add_child(child : HTMLElement | String | RawHTML) : <span class="k">self</span></span> add_child</a>, <a href="../../Components/Elements/ContainerElement.html#add_children%28%2Achildren%3AHTMLElement%7CString%7CRawHTML%29%3Aself-instance-method" class="tooltip"> <span>add_children(*children : HTMLElement | String | RawHTML) : <span class="k">self</span></span> add_children</a>, <a href="../../Components/Elements/ContainerElement.html#add_raw_html%28html%3AString%29%3Aself-instance-method" class="tooltip"> <span>add_raw_html(html : String) : <span class="k">self</span></span> add_raw_html</a>, <a href="../../Components/Elements/ContainerElement.html#build%28%26block%3Aself-%3ENil%29%3Aself-instance-method" class="tooltip"> <span>build(&block : <span class="k">self</span> -> Nil) : <span class="k">self</span></span> build</a>, <a href="../../Components/Elements/ContainerElement.html#children_count%3AInt32-instance-method" class="tooltip"> <span>children_count : Int32</span> children_count</a>, <a href="../../Components/Elements/ContainerElement.html#clear%3Aself-instance-method" class="tooltip"> <span>clear : <span class="k">self</span></span> clear</a>, <a href="../../Components/Elements/ContainerElement.html#empty%3F%3ABool-instance-method" class="tooltip"> <span>empty? : Bool</span> empty?</a>, <a href="../../Components/Elements/ContainerElement.html#render%3AString-instance-method" class="tooltip"> <span>render : String</span> render</a> <h3>Constructor methods inherited from class <code><a href="../../Components/Elements/ContainerElement.html">Components::Elements::ContainerElement</a></code></h3> <a href="../../Components/Elements/ContainerElement.html#new%28tag_name%3AString%2C%2A%2Aattrs%29-class-method" class="tooltip"> <span>new(tag_name : String, **attrs)</span> new</a> <h3>Instance methods inherited from class <code><a href="../../Components/Elements/HTMLElement.html">Components::Elements::HTMLElement</a></code></h3> <a href="../../Components/Elements/HTMLElement.html#%5B%5D%28name%3AString%29%3AString%7CNil-instance-method" class="tooltip"> <span>[](name : String) : String | Nil</span> []</a>, <a href="../../Components/Elements/HTMLElement.html#add_class%28class_names%3AString%29%3Aself-instance-method" class="tooltip"> <span>add_class(class_names : String) : <span class="k">self</span></span> add_class</a>, <a href="../../Components/Elements/HTMLElement.html#add_style%28styles%3AString%29%3Aself-instance-method" class="tooltip"> <span>add_style(styles : String) : <span class="k">self</span></span> add_style</a>, <a href="../../Components/Elements/HTMLElement.html#attributes%3AHash%28String%2CString%29-instance-method" class="tooltip"> <span>attributes : Hash(String, String)</span> attributes</a>, <a href="../../Components/Elements/HTMLElement.html#can_have_children%3F%3ABool-instance-method" class="tooltip"> <span>can_have_children? : Bool</span> can_have_children?</a>, <a href="../../Components/Elements/HTMLElement.html#children%3AArray%28HTMLElement%7CString%7CRawHTML%29-instance-method" class="tooltip"> <span>children : Array(HTMLElement | String | RawHTML)</span> children</a>, <a href="../../Components/Elements/HTMLElement.html#has_class%3F%28class_name%3AString%29%3ABool-instance-method" class="tooltip"> <span>has_class?(class_name : String) : Bool</span> has_class?</a>, <a href="../../Components/Elements/HTMLElement.html#remove_attribute%28name%3AString%29%3Aself-instance-method" class="tooltip"> <span>remove_attribute(name : String) : <span class="k">self</span></span> remove_attribute</a>, <a href="../../Components/Elements/HTMLElement.html#remove_class%28class_names%3AString%29%3Aself-instance-method" class="tooltip"> <span>remove_class(class_names : String) : <span class="k">self</span></span> remove_class</a>, <a href="../../Components/Elements/HTMLElement.html#render%3AString-instance-method" class="tooltip"> <span>render : String</span> render</a>, <a href="../../Components/Elements/HTMLElement.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method" class="tooltip"> <span>set_attribute(name : String, value : String | Nil) : <span class="k">self</span></span> set_attribute</a>, <a href="../../Components/Elements/HTMLElement.html#set_safe_style%28style%3ASafeStyleValue%29%3Aself-instance-method" class="tooltip"> <span>set_safe_style(style : SafeStyleValue) : <span class="k">self</span></span> set_safe_style</a>, <a href="../../Components/Elements/HTMLElement.html#set_safe_url_attribute%28name%3AString%2Curl%3ASafeURL%29%3Aself-instance-method" class="tooltip"> <span>set_safe_url_attribute(name : String, url : SafeURL) : <span class="k">self</span></span> set_safe_url_attribute</a>, <a href="../../Components/Elements/HTMLElement.html#tag_name%3AString-instance-method" class="tooltip"> <span>tag_name : String</span> tag_name</a>, <a href="../../Components/Elements/HTMLElement.html#to_s%28io%3AIO%29%3ANil-instance-method" class="tooltip"> <span>to_s(io : IO) : Nil</span> to_s</a>, <a href="../../Components/Elements/HTMLElement.html#void_element%3F%3ABool-instance-method" class="tooltip"> <span>void_element? : Bool</span> void_element?</a> <h3>Constructor methods inherited from class <code><a href="../../Components/Elements/HTMLElement.html">Components::Elements::HTMLElement</a></code></h3> <a href="../../Components/Elements/HTMLElement.html#new%28tag_name%3AString%2C%2A%2Aattrs%29-class-method" class="tooltip"> <span>new(tag_name : String, **attrs)</span> new</a> </div> <h2> <a id="constructor-detail" class="anchor" href="#constructor-detail"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Constructor Detail </h2> <div class="entry-detail" id="new(**attrs)-class-method"> <div class="signature"> def self.<strong>new</strong>(**attrs) <a class="method-permalink" href="#new%28%2A%2Aattrs%29-class-method">#</a> </div> <div class="doc"> <p>SafeHTML v1 (docs/SAFE_HTML_V1.md §3.5, §3.7): <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> is an HTML-DOCUMENT-VALUED attribute, not a plain string one. The browser HTML-entity-decodes the (correctly-escaped-for-the-<em>outer</em>-document) attribute value and then feeds the decoded result to a <em>fresh HTML parser</em> as the entire source document for the iframe's nested browsing context. <code>HTMLElement#escape_attribute</code> protects the <em>outer</em> document's parse (so the attribute stays well-formed) but does nothing to stop a <code><script></code> inside that re-parsed nested document from executing — value-escaping is the wrong tool for this sink, exactly as it is for <code>javascript:</code> URLs, just one layer removed. This makes <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> exactly as dangerous as <code><script></code> body content (see <code><a href="../../Components/Elements/Script.html">Elements::Script</a></code>), just carried in an attribute instead of element children — so it gets the identical treatment: a bare <code>String</code> is banned unconditionally, with a loud, reasoned, typed door as the only way through.</p> <p><code>document_sink_attribute?</code>/<code>vouch_document_attribute</code> (declared on <code><a href="../../Components/Elements/HTMLElement.html">HTMLElement</a></code>, §3.7) are the GENERAL mechanism this used to implement locally with its own <code>@vouched_srcdoc</code> ivar and a one-off <code>render_attributes</code> override. That override only ever re-checked the exact key <code>"srcdoc"</code> — a case/whitespace-varied direct mutation (<code>iframe.attributes["SRCDOC"] = "..."</code>) landed in a <em>different</em> Hash entry and sailed past it unchecked. Declaring <code>document_sink_attribute?</code> here instead means <code><a href="../../Components/Elements/HTMLElement.html">HTMLElement</a></code> <code>render_attributes</code>' single authority checks EVERY live attribute by normalized name, closing that gap without <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> needing its own render-time backstop at all.</p> </div> <br/> <div> [<a href="https://github.com/amberframework/asset_pipeline/blob/v0.36.0/src/components/elements/embedded/media.cr#L169" target="_blank">View source</a>] </div> </div> <div class="entry-detail" id="srcdoc(html:String,reason:String,**attrs):Iframe-class-method"> <div class="signature"> def self.<strong>srcdoc</strong>(html : String, reason : String, **attrs) : <a href="../../Components/Elements/Iframe.html">Iframe</a> <a class="method-permalink" href="#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">#</a> </div> <div class="doc"> <p>The typed, reasoned door for <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> — mirrors <code><a href="../../Components/Elements/Script.html#static%28js%3AString%2Creason%3AString%29%3AScript-class-method">Script.static(js, reason:)</a></code> / <code><a href="../../Components/SafeURL.html#unsafe%28url%3AString%2Creason%3AString%29%3ASafeURL-class-method">SafeURL.unsafe(url, reason:)</a></code>. Builds a fresh <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> with <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> set from the vouched HTML. Any other constructor kwarg (<code>src</code>, <code>title</code>, <code>sandbox</code>, <code>loading</code>, ...) is still accepted and still validated normally.</p> </div> <br/> <div> [<a href="https://github.com/amberframework/asset_pipeline/blob/v0.36.0/src/components/elements/embedded/media.cr#L186" target="_blank">View source</a>] </div> </div> <h2> <a id="instance-method-detail" class="anchor" href="#instance-method-detail"> <svg class="octicon-link" aria-hidden="true"> <use href="#octicon-link"/> </svg> </a> Instance Method Detail </h2> <div class="entry-detail" id="set_attribute(name:String,value:String|Nil):self-instance-method"> <div class="signature"> def <strong>set_attribute</strong>(name : String, value : String | Nil) : <span class="k">self</span> <a class="method-permalink" href="#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method">#</a> </div> <div class="doc"> <p>SafeHTML v1 (docs/SAFE_HTML_V1.md §3.5): reject a bare-<code>String</code> <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> here — this is the chokepoint both the constructor-kwarg path (<code>HTMLElement#initialize</code> calls <code><a href="../../Components/Elements/Iframe.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method">#set_attribute</a></code> once per kwarg) and the direct <code><a href="../../Components/Elements/Iframe.html#set_attribute%28name%3AString%2Cvalue%3AString%7CNil%29%3Aself-instance-method">#set_attribute</a></code> path funnel through, so one check closes both, matching how <code><a href="../../Components/Elements/UrlAttributeValidation.html">UrlAttributeValidation</a></code> closes <code>src</code>/<code>href</code> for the very same two paths. Name comparison is normalized (<code>strip.downcase</code>) so <code>SRCDOC</code>, <code>Srcdoc</code>, and <code>" srcdoc"</code> are all caught too — real HTML attribute names are ASCII-case-insensitive and tolerant of incidental whitespace from hand-built call sites, exactly like <code><a href="../../Components/Elements/UrlAttributeValidation.html">UrlAttributeValidation</a></code>'s own normalization. This is fail-FAST, call-time defense-in-depth — the render-time authority (<code>document_sink_attribute?</code> + <code><a href="../../Components/Elements/HTMLElement.html">HTMLElement</a> #validate_rendered_attribute!</code>, §3.7) is what's actually unbypassable.</p> </div> <br/> <div> [<a href="https://github.com/amberframework/asset_pipeline/blob/v0.36.0/src/components/elements/embedded/media.cr#L227" target="_blank">View source</a>] </div> </div> <div class="entry-detail" id="set_srcdoc(html:String,reason:String):self-instance-method"> <div class="signature"> def <strong>set_srcdoc</strong>(html : String, reason : String) : <span class="k">self</span> <a class="method-permalink" href="#set_srcdoc%28html%3AString%2Creason%3AString%29%3Aself-instance-method">#</a> </div> <div class="doc"> <p>The typed, reasoned door for setting <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> on an already-built <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> — the shape most call sites need (an <code><a href="../../Components/Elements/Iframe.html">Iframe</a></code> constructed first via ordinary kwargs, <code><a href="../../Components/Elements/Iframe.html#srcdoc%28html%3AString%2Creason%3AString%2C%2A%2Aattrs%29%3AIframe-class-method">.srcdoc</a></code> attached after), mirroring the already-existing instance-level typed setters <code>#set_safe_url_attribute</code> / <code>#set_safe_style</code>. <code>reason:</code> is mandatory, matching every other vouching door in this shard.</p> </div> <br/> <div> [<a href="https://github.com/amberframework/asset_pipeline/blob/v0.36.0/src/components/elements/embedded/media.cr#L199" target="_blank">View source</a>] </div> </div> </div> </body> </html>