Merge pull request #888 from davep/css-docs-screen-import

Modify the screen examples to import Screen from textual.screen
This commit is contained in:
Dave Pearson
2022-10-13 11:12:07 +01:00
committed by GitHub
3 changed files with 13 additions and 11 deletions

View File

@@ -1,4 +1,5 @@
from textual.app import App, Screen, ComposeResult from textual.app import App, ComposeResult
from textual.screen import Screen
from textual.widgets import Static from textual.widgets import Static

View File

@@ -1,4 +1,5 @@
from textual.app import App, Screen, ComposeResult from textual.app import App, ComposeResult
from textual.screen import Screen
from textual.widgets import Static from textual.widgets import Static

View File

@@ -10,7 +10,7 @@ Textual requires that there be at least one screen object and will create one im
!!! tip !!! tip
Try printing `widget.parent` to see what object your widget is connected to. Try printing `widget.parent` to see what object your widget is connected to.
<div class="excalidraw"> <div class="excalidraw">
--8<-- "docs/images/dom1.excalidraw.svg" --8<-- "docs/images/dom1.excalidraw.svg"
@@ -24,13 +24,13 @@ Let's look at a simple example of writing a screen class to simulate Window's [b
=== "screen01.py" === "screen01.py"
```python title="screen01.py" hl_lines="17-23 28" ```python title="screen01.py" hl_lines="18-24 29"
--8<-- "docs/examples/guide/screens/screen01.py" --8<-- "docs/examples/guide/screens/screen01.py"
``` ```
=== "screen01.css" === "screen01.css"
```sass title="screen01.css" ```sass title="screen01.css"
--8<-- "docs/examples/guide/screens/screen01.css" --8<-- "docs/examples/guide/screens/screen01.css"
``` ```
@@ -53,13 +53,13 @@ You can also _install_ new named screens dynamically with the [install_screen][t
=== "screen02.py" === "screen02.py"
```python title="screen02.py" hl_lines="30-31" ```python title="screen02.py" hl_lines="31-32"
--8<-- "docs/examples/guide/screens/screen02.py" --8<-- "docs/examples/guide/screens/screen02.py"
``` ```
=== "screen02.css" === "screen02.css"
```sass title="screen02.css" ```sass title="screen02.css"
--8<-- "docs/examples/guide/screens/screen02.css" --8<-- "docs/examples/guide/screens/screen02.css"
``` ```
@@ -96,7 +96,7 @@ You can also push screens with the `"app.push_screen"` action, which requires th
### Pop 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. 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 !!! note
@@ -115,7 +115,7 @@ You can also pop screens with the `"app.pop_screen"` action.
### Switch screen ### Switch screen
The [switch_screen][textual.app.App.switch_screen] method replaces the top of the stack with a new screen. The [switch_screen][textual.app.App.switch_screen] method replaces the top of the stack with a new screen.
<div class="excalidraw"> <div class="excalidraw">
--8<-- "docs/images/screens/switch_screen.excalidraw.svg" --8<-- "docs/images/screens/switch_screen.excalidraw.svg"
@@ -139,7 +139,7 @@ Screens can be used to implement modal dialogs. The following example pushes a s
=== "modal01.css" === "modal01.css"
```sass title="modal01.css" ```sass title="modal01.css"
--8<-- "docs/examples/guide/screens/modal01.css" --8<-- "docs/examples/guide/screens/modal01.css"
``` ```
@@ -147,5 +147,5 @@ Screens can be used to implement modal dialogs. The following example pushes a s
```{.textual path="docs/examples/guide/screens/modal01.py" press="q,_"} ```{.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. 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.