Merge pull request #824 from Textualize/docs-screen

Docs screen

docs/examples/guide/screens/modal01.css

@@ -0,0 +1,16 @@
+#dialog {
+    grid-size: 2;
+    grid-gutter: 1 2;
+    margin: 1 2;
+}
+
+#question {
+    column-span: 2;
+    content-align: center bottom;
+    width: 100%;
+    height: 100%;
+}
+
+Button {
+    width: 100%;
+}

docs/examples/guide/screens/modal01.py

@@ -0,0 +1,37 @@
+from textual.app import App, ComposeResult
+from textual.containers import Grid
+from textual.screen import Screen
+from textual.widgets import Static, Header, Footer, Button
+
+
+class QuitScreen(Screen):
+    def compose(self) -> ComposeResult:
+        yield Grid(
+            Static("Are you sure you want to quit?", id="question"),
+            Button("Quit", variant="error", id="quit"),
+            Button("Cancel", variant="primary", id="cancel"),
+            id="dialog",
+        )
+
+    def on_button_pressed(self, event: Button.Pressed) -> None:
+        if event.button.id == "quit":
+            self.app.exit()
+        else:
+            self.app.pop_screen()
+
+
+class ModalApp(App):
+    CSS_PATH = "modal01.css"
+    BINDINGS = [("q", "request_quit", "Quit")]
+
+    def compose(self) -> ComposeResult:
+        yield Header()
+        yield Footer()
+
+    def action_request_quit(self) -> None:
+        self.push_screen(QuitScreen())
+
+
+if __name__ == "__main__":
+    app = ModalApp()
+    app.run()

docs/examples/guide/screens/screen01.css

@@ -0,0 +1,18 @@
+BSOD {
+    align: center middle;
+    background: blue;
+    color: white;
+}
+
+BSOD>Static {
+    width: 70;    
+}
+
+#title {
+    content-align-horizontal: center;
+    text-style: reverse;
+}
+
+#any-key {
+    content-align-horizontal: center;
+}

docs/examples/guide/screens/screen01.py

@@ -0,0 +1,34 @@
+from textual.app import App, Screen, ComposeResult
+from textual.widgets import Static
+
+
+ERROR_TEXT = """
+An error has occurred. To continue:
+
+Press Enter to return to Windows, or
+
+Press CTRL+ALT+DEL to restart your computer. If you do this,
+you will lose any unsaved information in all open applications.
+
+Error: 0E : 016F : BFF9B3D4
+"""
+
+
+class BSOD(Screen):
+    BINDINGS = [("escape", "app.pop_screen", "Pop screen")]
+
+    def compose(self) -> ComposeResult:
+        yield Static(" Windows ", id="title")
+        yield Static(ERROR_TEXT)
+        yield Static("Press any key to continue [blink]_[/]", id="any-key")
+
+
+class BSODApp(App):
+    CSS_PATH = "screen01.css"
+    SCREENS = {"bsod": BSOD()}
+    BINDINGS = [("b", "push_screen('bsod')", "BSOD")]
+
+
+if __name__ == "__main__":
+    app = BSODApp()
+    app.run()

docs/examples/guide/screens/screen02.css

@@ -0,0 +1,18 @@
+BSOD {
+    align: center middle;
+    background: blue;
+    color: white;
+}
+
+BSOD>Static {
+    width: 70;    
+}
+
+#title {
+    content-align-horizontal: center;
+    text-style: reverse;
+}
+
+#any-key {
+    content-align-horizontal: center;
+}

docs/examples/guide/screens/screen02.py

@@ -0,0 +1,36 @@
+from textual.app import App, Screen, ComposeResult
+from textual.widgets import Static
+
+
+ERROR_TEXT = """
+An error has occurred. To continue:
+
+Press Enter to return to Windows, or
+
+Press CTRL+ALT+DEL to restart your computer. If you do this,
+you will lose any unsaved information in all open applications.
+
+Error: 0E : 016F : BFF9B3D4
+"""
+
+
+class BSOD(Screen):
+    BINDINGS = [("escape", "app.pop_screen", "Pop screen")]
+
+    def compose(self) -> ComposeResult:
+        yield Static(" Windows ", id="title")
+        yield Static(ERROR_TEXT)
+        yield Static("Press any key to continue [blink]_[/]", id="any-key")
+
+
+class BSODApp(App):
+    CSS_PATH = "screen02.css"
+    BINDINGS = [("b", "push_screen('bsod')", "BSOD")]
+
+    def on_mount(self) -> None:
+        self.install_screen(BSOD(), name="bsod")
+
+
+if __name__ == "__main__":
+    app = BSODApp()
+    app.run()

docs/guide/actions.md

@@ -131,10 +131,26 @@ Textual supports the following builtin actions which are defined on the app.
     options:
         show_root_heading: false
 
+### Push screen
+
+::: textual.app.App.action_push_screen
+
+
+### Pop screen
+
+::: textual.app.App.action_pop_screen
+
+
 ### Screenshot
 
 ::: textual.app.App.action_screenshot
 
+
+### Switch screen
+
+::: textual.app.App.action_switch_screen
+
+
 ### Toggle_dark
 
 ::: textual.app.App.action_toggle_dark

docs/guide/screens.md

@@ -1,12 +1,151 @@
 # Screens
 
-TODO: Screens docs
-
-- Explanation of screens
-- Screens API
-  - Install screen
-  - Uninstall screen
-  - Push screen
-  - Pop screen
-  - Switch Screen
-- Screens example
+This chapter covers Textual's screen API. We will discuss how to create screens and switch between them.
+
+## What is a screen?
+
+Screens are containers for widgets that occupy the dimensions of your terminal. There can be many screens in a given app, but only one screen is visible at a time.
+
+Textual requires that there be at least one screen object and will create one implicitly in the App class. If you don't change the screen, any widgets you [mount][textual.widget.Widget.mount] or [compose][textual.widget.Widget.compose] will be added to this default screen.
+
+!!! tip
+
+    Try printing `widget.parent` to see what object your widget is connected to. 
+
+<div class="excalidraw">
+--8<-- "docs/images/dom1.excalidraw.svg"
+</div>
+
+## Creating a screen
+
+You can create a screen by extending the [Screen][textual.screen.Screen] class which you can import from `textual.screen`. The screen may be styled in the same way as other widgets, with the exception that you can't modify the screen's dimensions (as these will always be the size of your terminal).
+
+Let's look at a simple example of writing a screen class to simulate Window's [blue screen of death](https://en.wikipedia.org/wiki/Blue_screen_of_death).
+
+=== "screen01.py"
+
+    ```python title="screen01.py" hl_lines="17-23 28"
+    --8<-- "docs/examples/guide/screens/screen01.py"
+    ```
+
+=== "screen01.css"
+
+    ```sass title="screen01.css" 
+    --8<-- "docs/examples/guide/screens/screen01.css"
+    ```
+
+=== "Output"
+
+    ```{.textual path="docs/examples/guide/screens/screen01.py" press="b,_"}
+    ```
+
+If you run this you will see an empty screen. Hit the ++b++ screen to show a blue screen of death. Hit ++escape++ to return to the default screen.
+
+The `BSOD` class above defines a screen with a key binding and compose method. These should be familiar as they work in the same way as apps.
+
+The app class has a new `SCREENS` class variable. Textual uses this class variable to associated a name with screen object (the name is used to reference screens in the screen API). Also in the app is a key binding associated with the action `"push_screen('bsod')"`. The screen class has a similar action `"pop_screen"` bound to the ++escape++ key. We will cover these actions below.
+
+## Named screens
+
+You can associate a screen with a name by defining a `SCREENS` class variable in your app, which should be dict that maps names on to Screen objects. The name of the screen may be used interchangeably with screen objects in much of the screen API.
+
+You can also _install_ new named screens dynamically with the [install_screen][textual.app.App.install_screen] method. The following example installs the `BSOD` screen in a mount handler rather than from the `SCREENS` variable.
+
+=== "screen02.py"
+
+    ```python title="screen02.py" hl_lines="30-31"
+    --8<-- "docs/examples/guide/screens/screen02.py"
+    ```
+
+=== "screen02.css"
+
+    ```sass title="screen02.css" 
+    --8<-- "docs/examples/guide/screens/screen02.css"
+    ```
+
+=== "Output"
+
+    ```{.textual path="docs/examples/guide/screens/screen02.py" press="b,_"}
+    ```
+
+Although both do the same thing, we recommend the `SCREENS` for screens that exist for the lifetime of your app.
+
+### Uninstalling screens
+
+Screens defined in `SCREENS` or added with [install_screen][textual.app.App.install_screen] are _installed_ screens. Textual will keep these screens in memory for the lifetime of your app.
+
+If you have installed a screen, but you later want it to be removed and cleaned up, you can call [uninstall_screen][textual.app.App.uninstall_screen].
+
+## Screen stack
+
+Textual keeps track of a _stack_ of screens. You can think of the screen stack as a stack of paper, where only the very top sheet is visible. If you remove the top sheet the paper underneath becomes visible. Screens work in a similar way.
+
+The active screen (top of the stack) will render the screen and receive input events. The following API methods on the App class can manipulate this stack, and let you decide which screen the user can interact with.
+
+### Push screen
+
+The [push_screen][textual.app.App.push_screen] method puts a screen on top of the stack and makes that screen active. You can call this method with the name of an installed screen, or a screen object.
+
+<div class="excalidraw">
+--8<-- "docs/images/screens/push_screen.excalidraw.svg"
+</div>
+
+#### Action
+
+You can also push screens with the `"app.push_screen"` action, which requires the name of an installed screen.
+
+### Pop screen
+
+The [pop_screen][textual.app.App.pop_screen] method removes the top-most screen from the stack, and makes the new top screen active. 
+
+!!! note
+
+    The screen stack must always have at least one screen. If you attempt to remove the last screen, Textual will raise a [ScreenStackError][textual.app.ScreenStackError] exception.
+
+<div class="excalidraw">
+--8<-- "docs/images/screens/pop_screen.excalidraw.svg"
+</div>
+
+
+When you pop a screen it will be removed and deleted unless it has been installed or there is another copy of the screen on the stack.
+
+#### Action
+
+You can also pop screens with the `"app.pop_screen"` action.
+
+### Switch screen
+
+The [switch_screen][textual.app.App.switch_screen] method replaces the top of the stack with a new screen. 
+
+<div class="excalidraw">
+--8<-- "docs/images/screens/switch_screen.excalidraw.svg"
+</div>
+
+Like [pop_screen](#pop-screen), if the screen being replaced is not installed it will be removed and deleted.
+
+#### Action
+
+You can also switch screens with the `"app.switch_screen"` action which accepts the name of the screen to switch to.
+
+## Modal screens
+
+Screens can be used to implement modal dialogs. The following example pushes a screen when you hit the ++q++ key to ask you if you really want to quit.
+
+=== "modal01.py"
+
+    ```python title="modal01.py" hl_lines="18 20 32"
+    --8<-- "docs/examples/guide/screens/modal01.py"
+    ```
+
+=== "modal01.css"
+
+    ```sass title="modal01.css" 
+    --8<-- "docs/examples/guide/screens/modal01.css"
+    ```
+
+=== "Output"
+
+    ```{.textual path="docs/examples/guide/screens/modal01.py" press="q,_"}
+    ```
+
+Note the `request_quit` action in the app which pushes a new instance of `QuitScreen`. This makes the quit screen active. if you click cancel, the quit screen calls `pop_screen` to return the default screen. This also removes and deletes the `QuitScreen` object.

docs/reference/app.md

@@ -1 +1 @@
-::: textual.app.App
+::: textual.app