Skip to content

MkIFrame

Show source on GitHub

Node for embedding an IFrame.

Example: With caption

Jinja

{{ "https://phil65.github.io/mknodes/" | MkIFrame(width=600, height=800) }}

Python

MkIFrame('https://phil65.github.io/mknodes/', width=600, height=800)


<iframe width="600" height="800" src="https://phil65.github.io/mknodes/"></iframe>

<iframe width="600" height="800" src="https://phil65.github.io/mknodes/"></iframe>

Bases: MkTemplate

__init__ 

__init__(url: str, *, width: int = 300, height: int = 150, **kwargs: Any)

Parameters:

Name Type Description Default
url str

Url to display in a frame

 required
width int

width of frame in pixels

 300
height int

height of frame in pixels

 150
kwargs Any

Keyword arguments passed to parent

 {}
Name Children Inherits
MkTemplate
mknodes.templatenodes.mktemplate
Node representing a jinja template.		 
graph TD
  94596167927680["mkiframe.MkIFrame"]
  94596168228624["mktemplate.MkTemplate"]
  94596169139824["mkcontainer.MkContainer"]
  94596169136704["mknode.MkNode"]
  94596171773984["node.Node"]
  139930746687680["builtins.object"]
  94596168228624 --> 94596167927680
  94596169139824 --> 94596168228624
  94596169136704 --> 94596169139824
  94596171773984 --> 94596169136704
  139930746687680 --> 94596171773984
/home/runner/work/mknodes/mknodes/mknodes/basenodes/mkiframe/metadata.toml
[metadata]
icon = "mdi:web-box"
name = "MkIFrame"

[examples.with_caption]
title = "With caption"
jinja = """
{{ "https://phil65.github.io/mknodes/" | MkIFrame(width=600, height=800) }}
"""

[output.html]
template = """
<iframe width="{{ node.width }}" height="{{ node.height }}" src="{{ node.url }}"></iframe>
"""
mknodes.basenodes.mkiframe.MkIFrame
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class MkIFrame(mktemplate.MkTemplate):
    """Node for embedding an IFrame."""

    ICON = "material/web-box"

    def __init__(
        self,
        url: str,
        *,
        width: int = 300,
        height: int = 150,
        **kwargs: Any,
    ):
        """Constructor.

        Args:
            url: Url to display in a frame
            width: width of frame in pixels
            height: height of frame in pixels
            kwargs: Keyword arguments passed to parent
        """
        super().__init__("output/html/template", **kwargs)
        self.url = url
        self.width = width
        self.height = height