Skip to content

Typography Components

Components for rendering text, headings, and code.

pymiro.components.typography

Typography components for pymiro.

Code 

Code(
    text: str,
    size: int | None = None,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode

Renders a Code component.

Parameters:

Name Type Description Default
text str

Configuration for text.

 required
size int | None

Configuration for size.

 None
style dict[str, str] | None

Configuration for style.

 None
class_name str | None

Configuration for class_name.

 None
key str | None

Configuration for key.

 None

Returns:

Name Type Description
VNode VNode

The virtual DOM node representing this component.
Example 
from pymiro.components import Code

Code()
Source code in pymiro/components/typography.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
@component
def Code(
    text: str,
    size: int | None = None,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode:
    """
    Renders a Code component.

    Args:
        text: Configuration for text.
        size: Configuration for size.
        style: Configuration for style.
        class_name: Configuration for class_name.
        key: Configuration for key.

    Returns:
        VNode: The virtual DOM node representing this component.

    Example:
        ```python
        from pymiro.components import Code

        Code()
        ```
    """
    theme = use_theme()
    t = theme.typography
    _s = size if size is not None else t.size_sm

    s = {
        "font-size": f"{_s}px",
        "font-family": t.font_mono,
        "background-color": theme.colors.surface,
        "color": theme.colors.text_primary,
        "padding": "2px 4px",
        "border-radius": f"{theme.radius.sm}px",
    }
    if style:
        s.update(style)

    props = _build_props({"text": text}, s, class_name)
    return VNode(type="text", props=props, children=[], key=key)

Heading 

Heading(
    text: str,
    level: int = 1,
    color: str | None = None,
    bold: bool = True,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode

Renders a Heading component.

Parameters:

Name Type Description Default
text str

Configuration for text.

 required
level int

Configuration for level.

 1
color str | None

Configuration for color.

 None
bold bool

Configuration for bold.

 True
style dict[str, str] | None

Configuration for style.

 None
class_name str | None

Configuration for class_name.

 None
key str | None

Configuration for key.

 None

Returns:

Name Type Description
VNode VNode

The virtual DOM node representing this component.
Example 
from pymiro.components import Heading

Heading()
Source code in pymiro/components/typography.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@component
def Heading(
    text: str,
    level: int = 1,
    color: str | None = None,
    bold: bool = True,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode:
    """
    Renders a Heading component.

    Args:
        text: Configuration for text.
        level: Configuration for level.
        color: Configuration for color.
        bold: Configuration for bold.
        style: Configuration for style.
        class_name: Configuration for class_name.
        key: Configuration for key.

    Returns:
        VNode: The virtual DOM node representing this component.

    Example:
        ```python
        from pymiro.components import Heading

        Heading()
        ```
    """
    theme = use_theme()
    t = theme.typography
    size = {1: t.size_3xl, 2: t.size_2xl, 3: t.size_xl, 4: t.size_md}.get(
        level, t.size_3xl
    )
    _c = color if color is not None else theme.colors.text_primary

    s = {"font-size": f"{size}px", "color": _c}
    if bold:
        s["font-weight"] = str(t.weight_bold)

    if style:
        s.update(style)

    props = _build_props({"text": text}, s, class_name)
    return VNode(type="text", props=props, children=[], key=key)

Link(
    text: str,
    on_click: Callable[..., Any],
    color: str | None = None,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode

Renders a Link component.

Parameters:

Name Type Description Default
text str

Configuration for text.

 required
on_click Callable[..., Any]

Configuration for on_click.

 required
color str | None

Configuration for color.

 None
style dict[str, str] | None

Configuration for style.

 None
class_name str | None

Configuration for class_name.

 None
key str | None

Configuration for key.

 None

Returns:

Name Type Description
VNode VNode

The virtual DOM node representing this component.
Example 
from pymiro.components import Link

Link()
Source code in pymiro/components/typography.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
@component
def Link(
    text: str,
    on_click: Callable[..., Any],
    color: str | None = None,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode:
    """
    Renders a Link component.

    Args:
        text: Configuration for text.
        on_click: Configuration for on_click.
        color: Configuration for color.
        style: Configuration for style.
        class_name: Configuration for class_name.
        key: Configuration for key.

    Returns:
        VNode: The virtual DOM node representing this component.

    Example:
        ```python
        from pymiro.components import Link

        Link()
        ```
    """
    theme = use_theme()
    _c = color if color is not None else theme.colors.primary

    s = {"color": _c, "text-decoration": "underline", "cursor": "pointer"}
    if style:
        s.update(style)

    props = _build_props({"text": text, "on_click": on_click}, s, class_name)
    # Using button for link for proper click handling
    # We strip button styling via CSS
    props["style"] = (
        props.get("style", "")
        + "; border: none; background: transparent; text-align: left; padding: 0;"
    )
    return VNode(type="button", props=props, children=[], key=key)

Text 

Text(
    text: str,
    size: int | None = None,
    color: str | None = None,
    bold: bool = False,
    italic: bool = False,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode

Renders a Text component.

Parameters:

Name Type Description Default
text str

Configuration for text.

 required
size int | None

Configuration for size.

 None
color str | None

Configuration for color.

 None
bold bool

Configuration for bold.

 False
italic bool

Configuration for italic.

 False
style dict[str, str] | None

Configuration for style.

 None
class_name str | None

Configuration for class_name.

 None
key str | None

Configuration for key.

 None

Returns:

Name Type Description
VNode VNode

The virtual DOM node representing this component.
Example 
from pymiro.components import Text

Text()
Source code in pymiro/components/typography.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
@component
def Text(
    text: str,
    size: int | None = None,
    color: str | None = None,
    bold: bool = False,
    italic: bool = False,
    style: dict[str, str] | None = None,
    class_name: str | None = None,
    key: str | None = None,
) -> VNode:
    """
    Renders a Text component.

    Args:
        text: Configuration for text.
        size: Configuration for size.
        color: Configuration for color.
        bold: Configuration for bold.
        italic: Configuration for italic.
        style: Configuration for style.
        class_name: Configuration for class_name.
        key: Configuration for key.

    Returns:
        VNode: The virtual DOM node representing this component.

    Example:
        ```python
        from pymiro.components import Text

        Text()
        ```
    """
    theme = use_theme()
    t = theme.typography
    _s = size if size is not None else t.size_md
    _c = color if color is not None else theme.colors.text_primary

    s = {"font-size": f"{_s}px", "color": _c}
    if bold:
        s["font-weight"] = str(t.weight_bold)
    if italic:
        s["font-style"] = "italic"

    if style:
        s.update(style)

    props = _build_props({"text": text}, s, class_name)
    return VNode(type="text", props=props, children=[], key=key)