Skip to content

info_box

sleap_nn.config_generator.tui.widgets.info_box

Info box widget variants.

Provides styled information boxes for displaying hints, warnings, and errors.

Classes:

Name Description
ErrorBox

Convenience class for error-styled info box.
GuideBox

Multi-section guide box for parameter explanations.
InfoBox

Styled information box widget.
InfoBoxType

Types of info boxes with different styling.
SuccessBox

Convenience class for success-styled info box.
TipBox

Convenience class for tip-styled info box.
WarningBox

Convenience class for warning-styled info box.

ErrorBox

Bases: InfoBox

Convenience class for error-styled info box.

Methods:

Name Description
__init__

Initialize an error-styled info box.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
class ErrorBox(InfoBox):
    """Convenience class for error-styled info box."""

    def __init__(
        self,
        message: str,
        title: Optional[str] = "Error",
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize an error-styled info box."""
        super().__init__(
            message=message,
            box_type=InfoBoxType.ERROR,
            title=title,
            id=id,
            classes=classes,
        )

__init__(message, title='Error', id=None, classes=None)

Initialize an error-styled info box.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
def __init__(
    self,
    message: str,
    title: Optional[str] = "Error",
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize an error-styled info box."""
    super().__init__(
        message=message,
        box_type=InfoBoxType.ERROR,
        title=title,
        id=id,
        classes=classes,
    )

GuideBox

Bases: Static

Multi-section guide box for parameter explanations.

Displays structured guidance with multiple sections for explaining configuration parameters.

Methods:

Name Description
__init__

Initialize the guide box.
add_section

Add a section to the guide.
render

Render the guide box content.
update_sections

Replace all sections.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
class GuideBox(Static):
    """Multi-section guide box for parameter explanations.

    Displays structured guidance with multiple sections for
    explaining configuration parameters.
    """

    DEFAULT_CSS = """
    GuideBox {
        height: auto;
        padding: 1;
        margin: 1 0;
        border: solid $surface-lighten-2;
        background: $surface;
    }
    """

    def __init__(
        self,
        title: str = "Guide",
        sections: Optional[dict] = None,
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize the guide box.

        Args:
            title: Main title.
            sections: Dict mapping section titles to content.
            id: Widget ID.
            classes: CSS classes.
        """
        super().__init__(id=id, classes=classes)
        self._title = title
        self._sections = sections or {}

    def render(self) -> str:
        """Render the guide box content."""
        lines = [self._title, "─" * len(self._title)]

        for section_title, content in self._sections.items():
            lines.append("")
            lines.append(f"▸ {section_title}")
            # Indent content
            for line in content.split("\n"):
                lines.append(f"  {line}")

        return "\n".join(lines)

    def add_section(self, title: str, content: str) -> None:
        """Add a section to the guide.

        Args:
            title: Section title.
            content: Section content.
        """
        self._sections[title] = content
        self.refresh()

    def update_sections(self, sections: dict) -> None:
        """Replace all sections.

        Args:
            sections: Dict mapping section titles to content.
        """
        self._sections = sections
        self.refresh()

__init__(title='Guide', sections=None, id=None, classes=None)

Initialize the guide box.

Parameters:

Name Type Description Default
title str

Main title.

 'Guide'
sections Optional[dict]

Dict mapping section titles to content.

 None
id Optional[str]

Widget ID.

 None
classes Optional[str]

CSS classes.

 None
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
def __init__(
    self,
    title: str = "Guide",
    sections: Optional[dict] = None,
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize the guide box.

    Args:
        title: Main title.
        sections: Dict mapping section titles to content.
        id: Widget ID.
        classes: CSS classes.
    """
    super().__init__(id=id, classes=classes)
    self._title = title
    self._sections = sections or {}

add_section(title, content)

Add a section to the guide.

Parameters:

Name Type Description Default
title str

Section title.

 required
content str

Section content.

 required
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
274
275
276
277
278
279
280
281
282
def add_section(self, title: str, content: str) -> None:
    """Add a section to the guide.

    Args:
        title: Section title.
        content: Section content.
    """
    self._sections[title] = content
    self.refresh()

render()

Render the guide box content.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
261
262
263
264
265
266
267
268
269
270
271
272
def render(self) -> str:
    """Render the guide box content."""
    lines = [self._title, "─" * len(self._title)]

    for section_title, content in self._sections.items():
        lines.append("")
        lines.append(f"▸ {section_title}")
        # Indent content
        for line in content.split("\n"):
            lines.append(f"  {line}")

    return "\n".join(lines)

update_sections(sections)

Replace all sections.

Parameters:

Name Type Description Default
sections dict

Dict mapping section titles to content.

 required
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
284
285
286
287
288
289
290
291
def update_sections(self, sections: dict) -> None:
    """Replace all sections.

    Args:
        sections: Dict mapping section titles to content.
    """
    self._sections = sections
    self.refresh()

InfoBox

Bases: Static

Styled information box widget.

Displays informational content with visual styling to indicate the type of information (info, warning, success, error, tip).

Attributes:

Name Type Description
box_type

The type of info box (affects styling).
title

Optional title text.
message str

Main content text.

Methods:

Name Description
__init__

Initialize the info box.
render

Render the info box content.
update_message

Update the message content.
update_type

Update the box type.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
 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
 62
 63
 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
114
115
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
class InfoBox(Static):
    """Styled information box widget.

    Displays informational content with visual styling to indicate
    the type of information (info, warning, success, error, tip).

    Attributes:
        box_type: The type of info box (affects styling).
        title: Optional title text.
        message: Main content text.
    """

    DEFAULT_CSS = """
    InfoBox {
        height: auto;
        padding: 1;
        margin: 1 0;
        border-left: thick $accent;
        background: $surface;
    }

    InfoBox.info {
        border-left: thick #3b82f6;
    }

    InfoBox.warning {
        border-left: thick $warning;
    }

    InfoBox.success {
        border-left: thick $success;
    }

    InfoBox.error {
        border-left: thick $error;
    }

    InfoBox.tip {
        border-left: thick #a855f7;
    }
    """

    def __init__(
        self,
        message: str,
        box_type: InfoBoxType = InfoBoxType.INFO,
        title: Optional[str] = None,
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize the info box.

        Args:
            message: Content text.
            box_type: Type of info box.
            title: Optional title.
            id: Widget ID.
            classes: CSS classes.
        """
        super().__init__(id=id, classes=classes)
        self._message = message
        self._box_type = box_type
        self._title = title

        # Add type class
        self.add_class(box_type.value)

    @property
    def message(self) -> str:
        """Get the message content."""
        return self._message

    @message.setter
    def message(self, value: str) -> None:
        """Set the message content."""
        self._message = value
        self.refresh()

    def render(self) -> str:
        """Render the info box content."""
        lines = []

        # Icons for different types
        icons = {
            InfoBoxType.INFO: "ℹ",
            InfoBoxType.WARNING: "⚠",
            InfoBoxType.SUCCESS: "✓",
            InfoBoxType.ERROR: "✗",
            InfoBoxType.TIP: "💡",
        }
        icon = icons.get(self._box_type, "")

        if self._title:
            lines.append(f"{icon} {self._title}")
            lines.append("")

        lines.append(self._message)

        return "\n".join(lines)

    def update_message(self, message: str) -> None:
        """Update the message content.

        Args:
            message: New message text.
        """
        self._message = message
        self.refresh()

    def update_type(self, box_type: InfoBoxType) -> None:
        """Update the box type.

        Args:
            box_type: New box type.
        """
        # Remove old type class
        self.remove_class(self._box_type.value)
        # Add new type class
        self._box_type = box_type
        self.add_class(box_type.value)
        self.refresh()

message property writable

Get the message content.

__init__(message, box_type=InfoBoxType.INFO, title=None, id=None, classes=None)

Initialize the info box.

Parameters:

Name Type Description Default
message str

Content text.

 required
box_type InfoBoxType

Type of info box.

 INFO
title Optional[str]

Optional title.

 None
id Optional[str]

Widget ID.

 None
classes Optional[str]

CSS classes.

 None
Source code in sleap_nn/config_generator/tui/widgets/info_box.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
def __init__(
    self,
    message: str,
    box_type: InfoBoxType = InfoBoxType.INFO,
    title: Optional[str] = None,
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize the info box.

    Args:
        message: Content text.
        box_type: Type of info box.
        title: Optional title.
        id: Widget ID.
        classes: CSS classes.
    """
    super().__init__(id=id, classes=classes)
    self._message = message
    self._box_type = box_type
    self._title = title

    # Add type class
    self.add_class(box_type.value)

render()

Render the info box content.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def render(self) -> str:
    """Render the info box content."""
    lines = []

    # Icons for different types
    icons = {
        InfoBoxType.INFO: "ℹ",
        InfoBoxType.WARNING: "⚠",
        InfoBoxType.SUCCESS: "✓",
        InfoBoxType.ERROR: "✗",
        InfoBoxType.TIP: "💡",
    }
    icon = icons.get(self._box_type, "")

    if self._title:
        lines.append(f"{icon} {self._title}")
        lines.append("")

    lines.append(self._message)

    return "\n".join(lines)

update_message(message)

Update the message content.

Parameters:

Name Type Description Default
message str

New message text.

 required
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
122
123
124
125
126
127
128
129
def update_message(self, message: str) -> None:
    """Update the message content.

    Args:
        message: New message text.
    """
    self._message = message
    self.refresh()

update_type(box_type)

Update the box type.

Parameters:

Name Type Description Default
box_type InfoBoxType

New box type.

 required
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
131
132
133
134
135
136
137
138
139
140
141
142
def update_type(self, box_type: InfoBoxType) -> None:
    """Update the box type.

    Args:
        box_type: New box type.
    """
    # Remove old type class
    self.remove_class(self._box_type.value)
    # Add new type class
    self._box_type = box_type
    self.add_class(box_type.value)
    self.refresh()

InfoBoxType

Bases: str, Enum

Types of info boxes with different styling.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
12
13
14
15
16
17
18
19
class InfoBoxType(str, Enum):
    """Types of info boxes with different styling."""

    INFO = "info"
    WARNING = "warning"
    SUCCESS = "success"
    ERROR = "error"
    TIP = "tip"

SuccessBox

Bases: InfoBox

Convenience class for success-styled info box.

Methods:

Name Description
__init__

Initialize a success-styled info box.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
class SuccessBox(InfoBox):
    """Convenience class for success-styled info box."""

    def __init__(
        self,
        message: str,
        title: Optional[str] = "Success",
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize a success-styled info box."""
        super().__init__(
            message=message,
            box_type=InfoBoxType.SUCCESS,
            title=title,
            id=id,
            classes=classes,
        )

__init__(message, title='Success', id=None, classes=None)

Initialize a success-styled info box.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def __init__(
    self,
    message: str,
    title: Optional[str] = "Success",
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize a success-styled info box."""
    super().__init__(
        message=message,
        box_type=InfoBoxType.SUCCESS,
        title=title,
        id=id,
        classes=classes,
    )

TipBox

Bases: InfoBox

Convenience class for tip-styled info box.

Methods:

Name Description
__init__

Initialize a tip-styled info box.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
class TipBox(InfoBox):
    """Convenience class for tip-styled info box."""

    def __init__(
        self,
        message: str,
        title: Optional[str] = "Tip",
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize a tip-styled info box."""
        super().__init__(
            message=message,
            box_type=InfoBoxType.TIP,
            title=title,
            id=id,
            classes=classes,
        )

__init__(message, title='Tip', id=None, classes=None)

Initialize a tip-styled info box.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def __init__(
    self,
    message: str,
    title: Optional[str] = "Tip",
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize a tip-styled info box."""
    super().__init__(
        message=message,
        box_type=InfoBoxType.TIP,
        title=title,
        id=id,
        classes=classes,
    )

WarningBox

Bases: InfoBox

Convenience class for warning-styled info box.

Methods:

Name Description
__init__

Initialize a warning-styled info box.
Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class WarningBox(InfoBox):
    """Convenience class for warning-styled info box."""

    def __init__(
        self,
        message: str,
        title: Optional[str] = "Warning",
        id: Optional[str] = None,
        classes: Optional[str] = None,
    ):
        """Initialize a warning-styled info box."""
        super().__init__(
            message=message,
            box_type=InfoBoxType.WARNING,
            title=title,
            id=id,
            classes=classes,
        )

__init__(message, title='Warning', id=None, classes=None)

Initialize a warning-styled info box.

Source code in sleap_nn/config_generator/tui/widgets/info_box.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def __init__(
    self,
    message: str,
    title: Optional[str] = "Warning",
    id: Optional[str] = None,
    classes: Optional[str] = None,
):
    """Initialize a warning-styled info box."""
    super().__init__(
        message=message,
        box_type=InfoBoxType.WARNING,
        title=title,
        id=id,
        classes=classes,
    )