vimsheet.ui.help_screen

Full-screen help overlay with tabs, collapsible subgroups, and vim search.

class vimsheet.ui.help_screen.HelpScreen[source]

Bases: VimModalScreen

Modal overlay displaying help with tabbed sections and search.

DEFAULT_CSS = '\n    HelpScreen {\n        align: center middle;\n    }\n    HelpScreen > #help-container {\n        width: 88%;\n        height: 92%;\n        background: $surface;\n        border: round $primary;\n        padding: 0;\n    }\n    HelpScreen > #help-container > Tabs {\n        dock: top;\n        height: 3;\n    }\n    HelpScreen > #help-container > VerticalScroll {\n        height: 1fr;\n        padding: 0 2 1 2;\n    }\n    HelpScreen > #help-container > VerticalScroll > Static {\n        width: auto;\n    }\n    HelpScreen > #search-line {\n        dock: bottom;\n        height: 1;\n        padding: 0 2;\n        background: $primary-background;\n        display: none;\n    }\n    HelpScreen > #help-bar {\n        dock: bottom;\n        height: 1;\n        padding: 0 2;\n        background: $primary-background;\n        color: $text-disabled;\n    }\n    '

Default TCSS.

__init__()[source]

Initialize the screen.

Parameters:

  • name – The name of the screen.

  • id – The ID of the screen in the DOM.

  • classes – The CSS classes for the screen.

Return type:

None

compose()[source]

Called by Textual to create child widgets.

This method is called when a widget is mounted or by setting recompose=True when calling [refresh()][textual.widget.Widget.refresh].

Note that you don’t typically need to explicitly call this method.

Example

```python def compose(self) -> ComposeResult:

yield Header() yield Label(“Press the button below:”) yield Button() yield Footer()

```

Return type:

Iterable[Widget]

on_mount()[source]
Return type:

None

on_key(event)[source]
Return type:

None

action_next_tab()[source]
Return type:

None

action_prev_tab()[source]
Return type:

None

on_tabs_tab_activated(event)[source]
Parameters:

event (TabActivated)

Return type:

None

action_next_match()[source]
Return type:

None

action_prev_match()[source]
Return type:

None

can_focus = False

Widget may receive focus.

can_focus_children = True

Widget’s children may receive focus.