Skip to content

CommandList

This a really basic widget that displays what commands are available to use.

CommandList

Bases: Widget

Custom widget for listing commands for the shell.

Parameters:

Name Type Description Default
command_list List[str]

List of commands for the custom shell.

 required
Source code in src/textual_shell/widgets/command_list.py 
 8
 9
10
11
12
13
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
class CommandList(Widget):
    """
    Custom widget for listing commands for the shell.

    Args:
        command_list (List[str]): List of commands for the custom shell.
    """
    DEFAULT_CSS = """
        CommandList {
            background: transparent;
            border: round white;
            height: auto;
            width: 20;
            layout: vertical;

            Label {
                text-align: center;
            }

            TextArea {
                background: transparent;
                border: none;
                border-top: solid white;
                text-align: center;
            }
        }
    """

    def __init__(
        self, 
        command_list: Annotated[List[str], 'List of commands for the custom shell.'],
    ) -> None:
        self.commands = command_list
        super().__init__()

    def on_mount(self):
        ta = self.query_one(TextArea)
        ta.can_focus = False

    def compose(self) -> ComposeResult:
        yield Label('Commands')
        yield TextArea(
            '\n'.join(self.commands),
            read_only=True
        )