MkSpeechBubble

Show source on GitHub

Node for showing a css-based speech bubble.

ExamplesDocStringsBase classes⋔ Inheritance diagramNodeFileCode

Example: Regular

Jinja

{{ "some text" | MkSpeechBubble }}

Python

MkSpeechBubble('some text')

RenderedMarkdownHtmlRepr tree

some text

<div class="speech bottom" markdown="1">
some text
</div>

<div class="speech bottom">
<p>some text</p>
</div>

MkSpeechBubble
╰── MkText('some text')

Example: No arrow

Jinja

{{ "some text" | MkSpeechBubble(arrow=None) }}

Python

MkSpeechBubble('some text', arrow=None)

RenderedMarkdownHtmlRepr tree

some text

<div class="speech" markdown="1">
some text
</div>

<div class="speech">
<p>some text</p>
</div>

MkSpeechBubble
╰── MkText('some text')

Bases: MkContainer

Name	Children	Inherits
MkContainer mknodes.basenodes.mkcontainer A node containing other MkNodes.	MkBlock MkAdmonition MkBlockQuote MkCode MkTemplate MkList MkBaseTable MkTab MkTabContainer MkCritic MkAnnotation ...	MkNode

graph TD
  94420304102560["mkspeechbubble.MkSpeechBubble"]
  94420312299136["mkcontainer.MkContainer"]
  94420313076768["mknode.MkNode"]
  94420313236736["node.Node"]
  140608527347936["builtins.object"]
  94420312299136 --> 94420304102560
  94420313076768 --> 94420312299136
  94420313236736 --> 94420313076768
  140608527347936 --> 94420313236736

/home/runner/work/mknodes/mknodes/mknodes/basenodes/mkspeechbubble/metadata.toml

[metadata]
icon = "mdi:chat"
name = "MkSpeechBubble"

[[resources.css]]
filename = "speechbubble.css"

[examples.regular]
title = "Regular"
jinja = """
{{ "some text" | MkSpeechBubble }}
"""

[examples.no_arrow]
title = "No arrow"
jinja = """
{{ "some text" | MkSpeechBubble(arrow=None) }}
"""

[output.markdown]
template = """
<div class="speech{{ node.arrow | add(prefix=' ') }}" markdown="1">
{{node.items  | join(node.block_separator) }}
</div>
"""

class MkSpeechBubble(mkcontainer.MkContainer):
    """Node for showing a css-based speech bubble."""

    ICON = "material/chat"
    CSS = [resources.CSSFile("speechbubble.css")]

    def __init__(
        self,
        content: str | mknode.MkNode | list | None = None,
        *,
        arrow: Literal["top", "bottom", "left", "right"] | None = "bottom",
        **kwargs: Any,
    ):
        self.arrow = arrow
        super().__init__(content=content or [], **kwargs)

    def get_element(self) -> xml.Div:
        klass = f"speech {self.arrow}" if self.arrow else "speech"
        root = xml.Div(klass, markdown=True)
        root.text = "\n" + super()._to_markdown() + "\n"
        return root

    def _to_markdown(self) -> str:
        return self.get_element().to_string()