alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Move the tutorial over to using ScrollableContainer

Browse Source
This commit is contained in:
Dave Pearson
2023-04-24 13:13:11 +01:00
parent ca94c5eed0
commit 2055a8996f
7 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/examples/tutorial/stopwatch.py
View File

@@ -1,9 +1,9 @@
from time import monotonic from time import monotonic
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.reactive import reactive from textual.reactive import reactive
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -83,7 +83,7 @@ class StopwatchApp(App):
"""Called to add widgets to the app.""" """Called to add widgets to the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch(), id="timers") yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch(), id="timers")
def action_add_stopwatch(self) -> None: def action_add_stopwatch(self) -> None:
"""An action to add a timer.""" """An action to add a timer."""

6
docs/examples/tutorial/stopwatch02.py
View File

@@ -1,6 +1,6 @@
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -27,7 +27,7 @@ class StopwatchApp(App):
"""Create child widgets for the app.""" """Create child widgets for the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch()) yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch())
def action_toggle_dark(self) -> None: def action_toggle_dark(self) -> None:
"""An action to toggle dark mode.""" """An action to toggle dark mode."""

6
docs/examples/tutorial/stopwatch03.py
View File

@@ -1,6 +1,6 @@
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -28,7 +28,7 @@ class StopwatchApp(App):
"""Create child widgets for the app.""" """Create child widgets for the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch()) yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch())
def action_toggle_dark(self) -> None: def action_toggle_dark(self) -> None:
"""An action to toggle dark mode.""" """An action to toggle dark mode."""

6
docs/examples/tutorial/stopwatch04.py
View File

@@ -1,6 +1,6 @@
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -35,7 +35,7 @@ class StopwatchApp(App):
"""Create child widgets for the app.""" """Create child widgets for the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch()) yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch())
def action_toggle_dark(self) -> None: def action_toggle_dark(self) -> None:
"""An action to toggle dark mode.""" """An action to toggle dark mode."""

6
docs/examples/tutorial/stopwatch05.py
View File

@@ -1,9 +1,9 @@
from time import monotonic from time import monotonic
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.reactive import reactive from textual.reactive import reactive
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -55,7 +55,7 @@ class StopwatchApp(App):
"""Create child widgets for the app.""" """Create child widgets for the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch()) yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch())
def action_toggle_dark(self) -> None: def action_toggle_dark(self) -> None:
"""An action to toggle dark mode.""" """An action to toggle dark mode."""

6
docs/examples/tutorial/stopwatch06.py
View File

@@ -1,9 +1,9 @@
from time import monotonic from time import monotonic
from textual.app import App, ComposeResult from textual.app import App, ComposeResult
from textual.containers import Container from textual.containers import ScrollableContainer
from textual.reactive import reactive from textual.reactive import reactive
from textual.widgets import Button, Header, Footer, Static from textual.widgets import Button, Footer, Header, Static
class TimeDisplay(Static): class TimeDisplay(Static):
@@ -78,7 +78,7 @@ class StopwatchApp(App):
"""Called to add widgets to the app.""" """Called to add widgets to the app."""
yield Header() yield Header()
yield Footer() yield Footer()
yield Container(Stopwatch(), Stopwatch(), Stopwatch()) yield ScrollableContainer(Stopwatch(), Stopwatch(), Stopwatch())
def action_toggle_dark(self) -> None: def action_toggle_dark(self) -> None:
"""An action to toggle dark mode.""" """An action to toggle dark mode."""

6
docs/tutorial.md
View File

@@ -157,7 +157,7 @@ Let's add those to the app. Just a skeleton for now, we will add the rest of the
--8<-- "docs/examples/tutorial/stopwatch02.py" --8<-- "docs/examples/tutorial/stopwatch02.py"
``` ```
We've imported two new widgets in this code: `Button`, which creates a clickable button, and `Static` which is a base class for a simple control. We've also imported `Container` from `textual.containers` which (as the name suggests) is a `Widget` which contains other widgets. We've imported two new widgets in this code: `Button`, which creates a clickable button, and `Static` which is a base class for a simple control. We've also imported `ScrollableContainer` from `textual.containers` which (as the name suggests) is a `Widget` which contains other widgets.
We've defined an empty `TimeDisplay` widget by extending `Static`. We will flesh this out later. We've defined an empty `TimeDisplay` widget by extending `Static`. We will flesh this out later.
@@ -174,7 +174,7 @@ The Button constructor takes a label to be displayed in the button (`"Start"`, `
To add widgets to our application we first need to yield them from the app's `compose()` method: To add widgets to our application we first need to yield them from the app's `compose()` method:
The new line in `StopwatchApp.compose()` yields a single `Container` object which will create a scrolling list of stopwatches. When classes contain other widgets (like `Container`) they will typically accept their child widgets as positional arguments. We want to start the app with three stopwatches, so we construct three `Stopwatch` instances and pass them to the container's constructor. The new line in `StopwatchApp.compose()` yields a single `ScrollableContainer` object which will create a scrolling list of stopwatches. When classes contain other widgets (like `ScrollableContainer`) they will typically accept their child widgets as positional arguments. We want to start the app with three stopwatches, so we construct three `Stopwatch` instances and pass them to the container's constructor.
### The unstyled app ### The unstyled app
@@ -438,7 +438,7 @@ Let's use these methods to implement adding and removing stopwatches to our app.
Here's a summary of the changes: Here's a summary of the changes:
- The `Container` object in `StopWatchApp` grew a `"timers"` ID. - The `ScrollableContainer` object in `StopWatchApp` grew a `"timers"` ID.
- Added `action_add_stopwatch` to add a new stopwatch. - Added `action_add_stopwatch` to add a new stopwatch.
- Added `action_remove_stopwatch` to remove a stopwatch. - Added `action_remove_stopwatch` to remove a stopwatch.
- Added keybindings for the actions. - Added keybindings for the actions.