Skip to content

dialogs

Modal dialog screens for the Textual frontend.

ConfirmScreen

Bases: ModalScreen[bool]

A Yes/No confirmation dialog.

Dismisses with True if the user selects Yes, False otherwise (including pressing Escape).

Source code in src/personal_os_setup/frontend/dialogs.py 
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class ConfirmScreen(ModalScreen[bool]):
    """A Yes/No confirmation dialog.

    Dismisses with ``True`` if the user selects **Yes**, ``False`` otherwise
    (including pressing **Escape**).
    """

    DEFAULT_CSS = """
    ConfirmScreen {
        align: center middle;
    }
    ConfirmScreen > Vertical {
        width: 60%;
        max-width: 80;
        height: auto;
        border: thick $accent;
        background: $panel;
        padding: 1 2;
    }
    ConfirmScreen #confirm-title {
        text-style: bold;
        color: $accent;
        margin-bottom: 1;
    }
    ConfirmScreen #confirm-buttons {
        margin-top: 1;
        height: auto;
        align: right middle;
    }
    ConfirmScreen Button {
        margin-left: 1;
    }
    """

    BINDINGS = [("escape", "cancel", "Cancel")]

    def __init__(self, *, title: str, text: str) -> None:
        super().__init__()
        self._title = title
        self._text = text

    def compose(self) -> ComposeResult:
        with Vertical():
            yield Label(self._title, id="confirm-title")
            yield Label(self._text)
            with Horizontal(id="confirm-buttons"):
                yield Button("Yes", id="confirm-yes", variant="success")
                yield Button("No", id="confirm-no", variant="error")

    @on(Button.Pressed, "#confirm-yes")
    def _yes(self) -> None:
        self.dismiss(True)

    @on(Button.Pressed, "#confirm-no")
    def _no(self) -> None:
        self.dismiss(False)

    def action_cancel(self) -> None:
        self.dismiss(False)

PromptScreen

Bases: ModalScreen[str | None]

A single-line text prompt dialog.

Dismisses with the entered text if the user clicks OK, or None if the user cancels (including pressing Escape).

Source code in src/personal_os_setup/frontend/dialogs.py 
 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
class PromptScreen(ModalScreen[str | None]):
    """A single-line text prompt dialog.

    Dismisses with the entered text if the user clicks **OK**, or ``None``
    if the user cancels (including pressing **Escape**).
    """

    DEFAULT_CSS = """
    PromptScreen {
        align: center middle;
    }
    PromptScreen > Vertical {
        width: 70%;
        max-width: 90;
        height: auto;
        border: thick $accent;
        background: $panel;
        padding: 1 2;
    }
    PromptScreen #prompt-label {
        margin-bottom: 1;
    }
    PromptScreen #prompt-buttons {
        margin-top: 1;
        height: auto;
        align: right middle;
    }
    PromptScreen Button {
        margin-left: 1;
    }
    """

    BINDINGS = [("escape", "cancel", "Cancel")]

    def __init__(self, *, title: str, label: str, initial: str) -> None:
        super().__init__()
        self._title = title
        self._label = label
        self._initial = initial

    def compose(self) -> ComposeResult:
        with Vertical():
            yield Label(self._title, id="prompt-title")
            yield Label(self._label, id="prompt-label")
            yield Input(self._initial, id="prompt-input")
            with Horizontal(id="prompt-buttons"):
                yield Button("OK", id="prompt-ok", variant="success")
                yield Button("Cancel", id="prompt-cancel", variant="error")

    def on_mount(self) -> None:
        self.query_one("#prompt-input", Input).focus()

    @on(Input.Submitted, "#prompt-input")
    def _submitted(self, event: Input.Submitted) -> None:
        self.dismiss(event.value)

    @on(Button.Pressed, "#prompt-ok")
    def _ok(self) -> None:
        self.dismiss(self.query_one("#prompt-input", Input).value)

    @on(Button.Pressed, "#prompt-cancel")
    def _cancel(self) -> None:
        self.dismiss(None)

    def action_cancel(self) -> None:
        self.dismiss(None)