110 lines
2.7 KiB
Python
110 lines
2.7 KiB
Python
|
from __future__ import annotations
|
||
|
|
|
||
|
|
from textwrap import dedent
|
||
|
|
|
||
|
|
from textual.app import ComposeResult
|
||
|
|
from textual.css.query import NoMatches
|
||
|
|
from textual.widget import Widget
|
||
|
|
from textual.widgets import KeyPanel, Markdown
|
||
|
|
|
||
|
|
|
||
|
|
class HelpPanel(Widget):
|
||
|
|
"""
|
||
|
|
Shows context sensitive help for the currently focused widget.
|
||
|
|
"""
|
||
|
|
|
||
|
|
DEFAULT_CSS = """
|
||
|
|
|
||
|
|
HelpPanel {
|
||
|
|
split: right;
|
||
|
|
width: 33%;
|
||
|
|
min-width: 30;
|
||
|
|
max-width: 60;
|
||
|
|
border-left: vkey $foreground 30%;
|
||
|
|
padding: 0 1;
|
||
|
|
height: 1fr;
|
||
|
|
padding-right: 1;
|
||
|
|
layout: vertical;
|
||
|
|
height: 100%;
|
||
|
|
|
||
|
|
&:ansi {
|
||
|
|
background: ansi_default;
|
||
|
|
border-left: vkey ansi_black;
|
||
|
|
|
||
|
|
Markdown, KeyPanel {
|
||
|
|
background: ansi_default;
|
||
|
|
}
|
||
|
|
.bindings-table--divide {
|
||
|
|
color: transparent;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
#widget-help {
|
||
|
|
height: auto;
|
||
|
|
max-height: 50%;
|
||
|
|
width: 1fr;
|
||
|
|
padding: 0;
|
||
|
|
margin: 0;
|
||
|
|
padding: 1 0;
|
||
|
|
margin-top: 1;
|
||
|
|
display: none;
|
||
|
|
background: $panel;
|
||
|
|
|
||
|
|
&:ansi {
|
||
|
|
background: ansi_default;
|
||
|
|
}
|
||
|
|
|
||
|
|
MarkdownBlock {
|
||
|
|
padding-left: 2;
|
||
|
|
padding-right: 2;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
&.-show-help #widget-help {
|
||
|
|
display: block;
|
||
|
|
}
|
||
|
|
|
||
|
|
KeyPanel#keys-help {
|
||
|
|
width: 1fr;
|
||
|
|
height: 1fr;
|
||
|
|
min-width: initial;
|
||
|
|
split: initial;
|
||
|
|
border-left: none;
|
||
|
|
padding: 0;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
DEFAULT_CLASSES = "-textual-system"
|
||
|
|
|
||
|
|
def on_mount(self):
|
||
|
|
def update_help(focused_widget: Widget | None):
|
||
|
|
self.update_help(focused_widget)
|
||
|
|
|
||
|
|
self.watch(self.screen, "focused", update_help)
|
||
|
|
|
||
|
|
def update_help(self, focused_widget: Widget | None) -> None:
|
||
|
|
"""Update the help for the focused widget.
|
||
|
|
|
||
|
|
Args:
|
||
|
|
focused_widget: The currently focused widget, or `None` if no widget was focused.
|
||
|
|
"""
|
||
|
|
if not self.app.app_focus:
|
||
|
|
return
|
||
|
|
if not self.screen.is_active:
|
||
|
|
return
|
||
|
|
self.set_class(focused_widget is not None, "-show-help")
|
||
|
|
if focused_widget is not None:
|
||
|
|
help = focused_widget.HELP or ""
|
||
|
|
if not help:
|
||
|
|
self.remove_class("-show-help")
|
||
|
|
try:
|
||
|
|
self.query_one(Markdown).update(dedent(help.rstrip()))
|
||
|
|
except NoMatches:
|
||
|
|
pass
|
||
|
|
|
||
|
|
def compose(self) -> ComposeResult:
|
||
|
|
yield Markdown(id="widget-help")
|
||
|
|
yield KeyPanel(id="keys-help")
|