Renamed 'Vertical' to 'VerticalScroll'.

Related issues: #1957.
Textualize · Mar 8, 2023 · 8565d3c · 8565d3c
1 parent b6c5337
commit 8565d3c
Show file tree

Hide file tree

Showing 47 changed files with 121 additions and 127 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Updated styling to make it clear DataTable grows horizontally https://github.com/Textualize/textual/pull/1946
 - Changed the `Checkbox` character due to issues with Windows Terminal and Windows 10 https://github.com/Textualize/textual/issues/1934
 - Changed the `RadioButton` character due to issues with Windows Terminal and Windows 10 and 11 https://github.com/Textualize/textual/issues/1934
+- Renamed `Vertical` to `VerticalScroll` https://github.com/Textualize/textual/issues/1957
 
 ### Added
 

diff --git a/docs/blog/snippets/2022-12-07-responsive-app-background-task/blocking01.py b/docs/blog/snippets/2022-12-07-responsive-app-background-task/blocking01.py
@@ -1,9 +1,9 @@
-from random import randint
 import time
+from random import randint
 
 from textual.app import App, ComposeResult
 from textual.color import Color
-from textual.containers import Grid, Vertical
+from textual.containers import Grid, VerticalScroll
 from textual.widget import Widget
 from textual.widgets import Footer, Label
 
@@ -28,7 +28,7 @@ class MyApp(App[None]):
     def compose(self) -> ComposeResult:
         yield Grid(
             ColourChanger(),
-            Vertical(id="log"),
+            VerticalScroll(id="log"),
         )
         yield Footer()
 

diff --git a/docs/blog/snippets/2022-12-07-responsive-app-background-task/blocking02.py b/docs/blog/snippets/2022-12-07-responsive-app-background-task/blocking02.py
@@ -1,10 +1,10 @@
 import asyncio
-from random import randint
 import time
+from random import randint
 
 from textual.app import App, ComposeResult
 from textual.color import Color
-from textual.containers import Grid, Vertical
+from textual.containers import Grid, VerticalScroll
 from textual.widget import Widget
 from textual.widgets import Footer, Label
 
@@ -29,7 +29,7 @@ class MyApp(App[None]):
     def compose(self) -> ComposeResult:
         yield Grid(
             ColourChanger(),
-            Vertical(id="log"),
+            VerticalScroll(id="log"),
         )
         yield Footer()
 

diff --git a/docs/blog/snippets/2022-12-07-responsive-app-background-task/nonblocking01.py b/docs/blog/snippets/2022-12-07-responsive-app-background-task/nonblocking01.py
@@ -1,10 +1,10 @@
 import asyncio
-from random import randint
 import time
+from random import randint
 
 from textual.app import App, ComposeResult
 from textual.color import Color
-from textual.containers import Grid, Vertical
+from textual.containers import Grid, VerticalScroll
 from textual.widget import Widget
 from textual.widgets import Footer, Label
 
@@ -29,7 +29,7 @@ class MyApp(App[None]):
     def compose(self) -> ComposeResult:
         yield Grid(
             ColourChanger(),
-            Vertical(id="log"),
+            VerticalScroll(id="log"),
         )
         yield Footer()
 

diff --git a/docs/examples/events/dictionary.py b/docs/examples/events/dictionary.py
@@ -6,9 +6,10 @@
     raise ImportError("Please install httpx with 'pip install httpx' ")
 
 from rich.json import JSON
+
 from textual.app import App, ComposeResult
-from textual.containers import Vertical
-from textual.widgets import Static, Input
+from textual.containers import VerticalScroll
+from textual.widgets import Input, Static
 
 
 class DictionaryApp(App):
@@ -18,7 +19,7 @@ class DictionaryApp(App):
 
     def compose(self) -> ComposeResult:
         yield Input(placeholder="Search for a word")
-        yield Vertical(Static(id="results"), id="results-container")
+        yield VerticalScroll(Static(id="results"), id="results-container")
 
     async def on_input_changed(self, message: Input.Changed) -> None:
         """A coroutine to handle a text changed message."""

diff --git a/docs/examples/guide/layout/combining_layouts.py b/docs/examples/guide/layout/combining_layouts.py
@@ -1,5 +1,5 @@
 from textual.app import App, ComposeResult
-from textual.containers import Container, Horizontal, Vertical
+from textual.containers import Container, Horizontal, VerticalScroll
 from textual.widgets import Header, Static
 
 
@@ -9,7 +9,7 @@ class CombiningLayoutsExample(App):
     def compose(self) -> ComposeResult:
         yield Header()
         with Container(id="app-grid"):
-            with Vertical(id="left-pane"):
+            with VerticalScroll(id="left-pane"):
                 for number in range(15):
                     yield Static(f"Vertical layout, child {number}")
             with Horizontal(id="top-right"):

diff --git a/docs/examples/guide/layout/utility_containers.py b/docs/examples/guide/layout/utility_containers.py
@@ -1,5 +1,5 @@
 from textual.app import App, ComposeResult
-from textual.containers import Horizontal, Vertical
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Static
 
 
@@ -8,12 +8,12 @@ class UtilityContainersExample(App):
 
     def compose(self) -> ComposeResult:
         yield Horizontal(
-            Vertical(
+            VerticalScroll(
                 Static("One"),
                 Static("Two"),
                 classes="column",
             ),
-            Vertical(
+            VerticalScroll(
                 Static("Three"),
                 Static("Four"),
                 classes="column",

diff --git a/docs/examples/guide/layout/utility_containers_using_with.py b/docs/examples/guide/layout/utility_containers_using_with.py
@@ -1,5 +1,5 @@
 from textual.app import App, ComposeResult
-from textual.containers import Horizontal, Vertical
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Static
 
 
@@ -8,10 +8,10 @@ class UtilityContainersExample(App):
 
     def compose(self) -> ComposeResult:
         with Horizontal():
-            with Vertical(classes="column"):
+            with VerticalScroll(classes="column"):
                 yield Static("One")
                 yield Static("Two")
-            with Vertical(classes="column"):
+            with VerticalScroll(classes="column"):
                 yield Static("Three")
                 yield Static("Four")
 

diff --git a/docs/examples/styles/height_comparison.py b/docs/examples/styles/height_comparison.py
@@ -1,6 +1,6 @@
 from textual.app import App
-from textual.containers import Vertical
-from textual.widgets import Placeholder, Label, Static
+from textual.containers import VerticalScroll
+from textual.widgets import Label, Placeholder, Static
 
 
 class Ruler(Static):
@@ -11,7 +11,7 @@ def compose(self):
 
 class HeightComparisonApp(App):
     def compose(self):
-        yield Vertical(
+        yield VerticalScroll(
             Placeholder(id="cells"),  # (1)!
             Placeholder(id="percent"),
             Placeholder(id="w"),

diff --git a/docs/examples/styles/max_width.py b/docs/examples/styles/max_width.py
@@ -1,11 +1,11 @@
 from textual.app import App
-from textual.containers import Vertical
+from textual.containers import VerticalScroll
 from textual.widgets import Placeholder
 
 
 class MaxWidthApp(App):
     def compose(self):
-        yield Vertical(
+        yield VerticalScroll(
             Placeholder("max-width: 50h", id="p1"),
             Placeholder("max-width: 999", id="p2"),
             Placeholder("max-width: 50%", id="p3"),

diff --git a/docs/examples/styles/min_width.css b/docs/examples/styles/min_width.css
@@ -1,4 +1,4 @@
-Vertical {
+VerticalScroll {
     height: 100%;
     width: 100%;
     overflow-x: auto;
@@ -10,7 +10,8 @@ Placeholder {
 }
 
 #p1 {
-    min-width: 25%;  /* (1)! */
+    min-width: 25%;
+    /* (1)! */
 }
 
 #p2 {

diff --git a/docs/examples/styles/min_width.py b/docs/examples/styles/min_width.py
@@ -1,11 +1,11 @@
 from textual.app import App
-from textual.containers import Vertical
+from textual.containers import VerticalScroll
 from textual.widgets import Placeholder
 
 
 class MinWidthApp(App):
     def compose(self):
-        yield Vertical(
+        yield VerticalScroll(
             Placeholder("min-width: 25%", id="p1"),
             Placeholder("min-width: 75%", id="p2"),
             Placeholder("min-width: 100", id="p3"),

diff --git a/docs/examples/styles/overflow.css b/docs/examples/styles/overflow.css
@@ -3,7 +3,7 @@ Screen {
     color: black;
 }
 
-Vertical {
+VerticalScroll {
     width: 1fr;
 }
 
@@ -13,7 +13,7 @@ Static {
     border: green wide;
     color: white 90%;
     height: auto;
-}    
+}
 
 #right {
     overflow-y: hidden;

diff --git a/docs/examples/styles/overflow.py b/docs/examples/styles/overflow.py
@@ -1,6 +1,6 @@
 from textual.app import App
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Static
-from textual.containers import Horizontal, Vertical
 
 TEXT = """I must not fear.
 Fear is the mind-killer.
@@ -14,8 +14,8 @@
 class OverflowApp(App):
     def compose(self):
         yield Horizontal(
-            Vertical(Static(TEXT), Static(TEXT), Static(TEXT), id="left"),
-            Vertical(Static(TEXT), Static(TEXT), Static(TEXT), id="right"),
+            VerticalScroll(Static(TEXT), Static(TEXT), Static(TEXT), id="left"),
+            VerticalScroll(Static(TEXT), Static(TEXT), Static(TEXT), id="right"),
         )
 
 

diff --git a/docs/examples/styles/scrollbar_size.py b/docs/examples/styles/scrollbar_size.py
@@ -1,5 +1,5 @@
 from textual.app import App
-from textual.containers import Vertical
+from textual.containers import VerticalScroll
 from textual.widgets import Label
 
 TEXT = """I must not fear.
@@ -14,7 +14,7 @@
 
 class ScrollbarApp(App):
     def compose(self):
-        yield Vertical(Label(TEXT * 5), classes="panel")
+        yield VerticalScroll(Label(TEXT * 5), classes="panel")
 
 
 app = ScrollbarApp(css_path="scrollbar_size.css")
diff --git a/docs/examples/styles/visibility_containers.py b/docs/examples/styles/visibility_containers.py
@@ -1,11 +1,11 @@
 from textual.app import App
-from textual.containers import Horizontal, Vertical
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Placeholder
 
 
 class VisibilityContainersApp(App):
     def compose(self):
-        yield Vertical(
+        yield VerticalScroll(
             Horizontal(
                 Placeholder(),
                 Placeholder(),

diff --git a/docs/examples/widgets/button.css b/docs/examples/widgets/button.css
@@ -2,7 +2,7 @@ Button {
     margin: 1 2;
 }
 
-Horizontal > Vertical {
+Horizontal>VerticalScroll {
     width: 24;
 }
 

diff --git a/docs/examples/widgets/button.py b/docs/examples/widgets/button.py
@@ -1,5 +1,5 @@
 from textual.app import App, ComposeResult
-from textual.containers import Horizontal, Vertical
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Button, Static
 
 
@@ -8,15 +8,15 @@ class ButtonsApp(App[str]):
 
     def compose(self) -> ComposeResult:
         yield Horizontal(
-            Vertical(
+            VerticalScroll(
                 Static("Standard Buttons", classes="header"),
                 Button("Default"),
                 Button("Primary!", variant="primary"),
                 Button.success("Success!"),
                 Button.warning("Warning!"),
                 Button.error("Error!"),
             ),
-            Vertical(
+            VerticalScroll(
                 Static("Disabled Buttons", classes="header"),
                 Button("Default", disabled=True),
                 Button("Primary!", variant="primary", disabled=True),

diff --git a/docs/examples/widgets/checkbox.css b/docs/examples/widgets/checkbox.css
@@ -2,7 +2,7 @@ Screen {
     align: center middle;
 }
 
-Vertical {
+VerticalScroll {
     width: auto;
     height: auto;
     border: solid $primary;

diff --git a/docs/examples/widgets/checkbox.py b/docs/examples/widgets/checkbox.py
@@ -1,13 +1,13 @@
 from textual.app import App, ComposeResult
-from textual.containers import Vertical
+from textual.containers import VerticalScroll
 from textual.widgets import Checkbox
 
 
 class CheckboxApp(App[None]):
     CSS_PATH = "checkbox.css"
 
     def compose(self) -> ComposeResult:
-        with Vertical():
+        with VerticalScroll():
             yield Checkbox("Arrakis :sweat:")
             yield Checkbox("Caladan")
             yield Checkbox("Chusuk")

diff --git a/docs/examples/widgets/placeholder.py b/docs/examples/widgets/placeholder.py
@@ -1,14 +1,13 @@
 from textual.app import App, ComposeResult
-from textual.containers import Container, Horizontal, Vertical
+from textual.containers import Container, Horizontal, VerticalScroll
 from textual.widgets import Placeholder
 
 
 class PlaceholderApp(App):
-
     CSS_PATH = "placeholder.css"
 
     def compose(self) -> ComposeResult:
-        yield Vertical(
+        yield VerticalScroll(
             Container(
                 Placeholder("This is a custom label for p1.", id="p1"),
                 Placeholder("Placeholder p2 here!", id="p2"),

diff --git a/docs/examples/widgets/radio_set_changed.css b/docs/examples/widgets/radio_set_changed.css
@@ -1,4 +1,4 @@
-Vertical {
+VerticalScroll {
     align: center middle;
 }
 

diff --git a/docs/examples/widgets/radio_set_changed.py b/docs/examples/widgets/radio_set_changed.py
@@ -1,13 +1,13 @@
 from textual.app import App, ComposeResult
-from textual.containers import Horizontal, Vertical
+from textual.containers import Horizontal, VerticalScroll
 from textual.widgets import Label, RadioButton, RadioSet
 
 
 class RadioSetChangedApp(App[None]):
     CSS_PATH = "radio_set_changed.css"
 
     def compose(self) -> ComposeResult:
-        with Vertical():
+        with VerticalScroll():
             with Horizontal():
                 with RadioSet():
                     yield RadioButton("Battlestar Galactica")