Deployed a396389 with MkDocs version: 1.5.3

Textualize · Mar 18, 2024 · fadc3c6 · fadc3c6
1 parent e5baaf9
commit fadc3c6
Show file tree

Hide file tree

Showing 287 changed files with 25,165 additions and 23,338 deletions.
diff --git a/404.html b/404.html
diff --git a/FAQ/index.html b/FAQ/index.html
diff --git a/api/app/index.html b/api/app/index.html
diff --git a/api/await_complete/index.html b/api/await_complete/index.html
diff --git a/api/await_remove/index.html b/api/await_remove/index.html
diff --git a/api/binding/index.html b/api/binding/index.html
diff --git a/api/cache/index.html b/api/cache/index.html
diff --git a/api/color/index.html b/api/color/index.html
diff --git a/api/command/index.html b/api/command/index.html
diff --git a/api/constants/index.html b/api/constants/index.html
diff --git a/api/containers/index.html b/api/containers/index.html
diff --git a/api/content_switcher/index.html b/api/content_switcher/index.html
diff --git a/api/coordinate/index.html b/api/coordinate/index.html
diff --git a/api/dom_node/index.html b/api/dom_node/index.html
diff --git a/api/errors/index.html b/api/errors/index.html
diff --git a/api/events/index.html b/api/events/index.html
diff --git a/api/filter/index.html b/api/filter/index.html
diff --git a/api/fuzzy_matcher/index.html b/api/fuzzy_matcher/index.html
diff --git a/api/geometry/index.html b/api/geometry/index.html
diff --git a/api/index.html b/api/index.html
diff --git a/api/lazy/index.html b/api/lazy/index.html
diff --git a/api/logger/index.html b/api/logger/index.html
diff --git a/api/logging/index.html b/api/logging/index.html
diff --git a/api/map_geometry/index.html b/api/map_geometry/index.html
diff --git a/api/message/index.html b/api/message/index.html
diff --git a/api/message_pump/index.html b/api/message_pump/index.html
diff --git a/api/on/index.html b/api/on/index.html
diff --git a/api/pilot/index.html b/api/pilot/index.html
diff --git a/api/query/index.html b/api/query/index.html
diff --git a/api/reactive/index.html b/api/reactive/index.html
diff --git a/api/renderables/index.html b/api/renderables/index.html
diff --git a/api/screen/index.html b/api/screen/index.html
diff --git a/api/scroll_view/index.html b/api/scroll_view/index.html
diff --git a/api/scrollbar/index.html b/api/scrollbar/index.html
diff --git a/api/signal/index.html b/api/signal/index.html
diff --git a/api/strip/index.html b/api/strip/index.html
diff --git a/api/suggester/index.html b/api/suggester/index.html
diff --git a/api/system_commands_source/index.html b/api/system_commands_source/index.html
diff --git a/api/timer/index.html b/api/timer/index.html
diff --git a/api/types/index.html b/api/types/index.html
diff --git a/api/validation/index.html b/api/validation/index.html
diff --git a/api/walk/index.html b/api/walk/index.html
diff --git a/api/widget/index.html b/api/widget/index.html
diff --git a/api/work/index.html b/api/work/index.html
diff --git a/api/worker/index.html b/api/worker/index.html
diff --git a/api/worker_manager/index.html b/api/worker_manager/index.html
diff --git a/assets/javascripts/bundle.e1c3ead8.min.js → assets/javascripts/bundle.c8d2eff1.min.js b/assets/javascripts/bundle.e1c3ead8.min.js → assets/javascripts/bundle.c8d2eff1.min.js
diff --git a/...ts/javascripts/bundle.e1c3ead8.min.js.map → ...ts/javascripts/bundle.c8d2eff1.min.js.map b/...ts/javascripts/bundle.e1c3ead8.min.js.map → ...ts/javascripts/bundle.c8d2eff1.min.js.map
diff --git a/assets/stylesheets/main.50c56a3b.min.css b/assets/stylesheets/main.50c56a3b.min.css
diff --git a/assets/stylesheets/main.50c56a3b.min.css.map b/assets/stylesheets/main.50c56a3b.min.css.map
diff --git a/assets/stylesheets/main.7e359304.min.css b/assets/stylesheets/main.7e359304.min.css
diff --git a/assets/stylesheets/main.7e359304.min.css.map b/assets/stylesheets/main.7e359304.min.css.map
diff --git a/blog/2022/11/06/new-blog/index.html b/blog/2022/11/06/new-blog/index.html
diff --git a/blog/2022/11/08/version-040/index.html b/blog/2022/11/08/version-040/index.html
diff --git a/blog/2022/11/20/stealing-open-source-code-from-textual/index.html b/blog/2022/11/20/stealing-open-source-code-from-textual/index.html
diff --git a/blog/2022/11/22/what-i-learned-from-my-first-non-trivial-pr/index.html b/blog/2022/11/22/what-i-learned-from-my-first-non-trivial-pr/index.html
diff --git a/blog/2022/11/24/spinners-and-progress-bars-in-textual/index.html b/blog/2022/11/24/spinners-and-progress-bars-in-textual/index.html
diff --git a/blog/2022/11/26/on-dog-food-the-original-metaverse-and-not-being-bored/index.html b/blog/2022/11/26/on-dog-food-the-original-metaverse-and-not-being-bored/index.html
diff --git a/blog/2022/12/07/letting-your-cook-multitask-while-bringing-water-to-a-boil/index.html b/blog/2022/12/07/letting-your-cook-multitask-while-bringing-water-to-a-boil/index.html
diff --git a/blog/2022/12/08/be-the-keymaster/index.html b/blog/2022/12/08/be-the-keymaster/index.html
diff --git a/blog/2022/12/11/version-060/index.html b/blog/2022/12/11/version-060/index.html
diff --git a/blog/2022/12/20/a-year-of-building-for-the-terminal/index.html b/blog/2022/12/20/a-year-of-building-for-the-terminal/index.html
diff --git a/blog/2022/12/30/a-better-asyncio-sleep-for-windows-to-fix-animation/index.html b/blog/2022/12/30/a-better-asyncio-sleep-for-windows-to-fix-animation/index.html
diff --git a/blog/2023/01/09/so-youre-looking-for-a-wee-bit-of-textual-help/index.html b/blog/2023/01/09/so-youre-looking-for-a-wee-bit-of-textual-help/index.html
diff --git a/blog/2023/02/11/the-heisenbug-lurking-in-your-async-code/index.html b/blog/2023/02/11/the-heisenbug-lurking-in-your-async-code/index.html
diff --git a/blog/2023/02/15/textual-0110-adds-a-beautiful-markdown-widget/index.html b/blog/2023/02/15/textual-0110-adds-a-beautiful-markdown-widget/index.html
diff --git a/blog/2023/02/24/textual-0120-adds-syntactical-sugar-and-batch-updates/index.html b/blog/2023/02/24/textual-0120-adds-syntactical-sugar-and-batch-updates/index.html
diff --git a/blog/2023/03/08/overhead-of-python-asyncio-tasks/index.html b/blog/2023/03/08/overhead-of-python-asyncio-tasks/index.html
diff --git a/blog/2023/03/09/textual-0140-shakes-up-posting-messages/index.html b/blog/2023/03/09/textual-0140-shakes-up-posting-messages/index.html
diff --git a/blog/2023/03/13/textual-0150-adds-a-tabs-widget/index.html b/blog/2023/03/13/textual-0150-adds-a-tabs-widget/index.html
diff --git a/blog/2023/03/15/no-async-async-with-python/index.html b/blog/2023/03/15/no-async-async-with-python/index.html
diff --git a/blog/2023/03/22/textual-0160-adds-tabbedcontent-and-border-titles/index.html b/blog/2023/03/22/textual-0160-adds-tabbedcontent-and-border-titles/index.html
diff --git a/blog/2023/03/29/textual-0170-adds-translucent-screens-and-option-list/index.html b/blog/2023/03/29/textual-0170-adds-translucent-screens-and-option-list/index.html
diff --git a/blog/2023/04/04/textual-0180-adds-api-for-managing-concurrent-workers/index.html b/blog/2023/04/04/textual-0180-adds-api-for-managing-concurrent-workers/index.html
diff --git a/blog/2023/05/03/textual-0230-improves-message-handling/index.html b/blog/2023/05/03/textual-0230-improves-message-handling/index.html
diff --git a/blog/2023/05/08/textual-0240-adds-a-select-control/index.html b/blog/2023/05/08/textual-0240-adds-a-select-control/index.html
diff --git a/...23/06/01/textual-adds-sparklines-selection-list-input-validation-and-tool-tips/index.html b/...23/06/01/textual-adds-sparklines-selection-list-input-validation-and-tool-tips/index.html
diff --git a/blog/2023/06/06/to-tui-or-not-to-tui/index.html b/blog/2023/06/06/to-tui-or-not-to-tui/index.html
diff --git a/blog/2023/07/03/textual-0290-refactors-dev-tools/index.html b/blog/2023/07/03/textual-0290-refactors-dev-tools/index.html
diff --git a/blog/2023/07/17/textual-0300-adds-desktop-style-notifications/index.html b/blog/2023/07/17/textual-0300-adds-desktop-style-notifications/index.html
diff --git a/blog/2023/07/27/using-rich-inspect-to-interrogate-python-objects/index.html b/blog/2023/07/27/using-rich-inspect-to-interrogate-python-objects/index.html
diff --git a/blog/2023/07/29/pull-requests-are-cake-or-puppies/index.html b/blog/2023/07/29/pull-requests-are-cake-or-puppies/index.html
diff --git a/blog/2023/09/06/what-is-textual-web/index.html b/blog/2023/09/06/what-is-textual-web/index.html
diff --git a/blog/2023/09/15/textual-0370-adds-a-command-palette/index.html b/blog/2023/09/15/textual-0370-adds-a-command-palette/index.html
diff --git a/blog/2023/09/18/things-i-learned-while-building-textuals-textarea/index.html b/blog/2023/09/18/things-i-learned-while-building-textuals-textarea/index.html
diff --git a/blog/2023/09/21/textual-0380-adds-a-syntax-aware-textarea/index.html b/blog/2023/09/21/textual-0380-adds-a-syntax-aware-textarea/index.html
diff --git a/blog/2023/10/04/announcing-textual-plotext/index.html b/blog/2023/10/04/announcing-textual-plotext/index.html
diff --git a/blog/2024/02/11/file-magic-with-the-python-standard-library/index.html b/blog/2024/02/11/file-magic-with-the-python-standard-library/index.html
diff --git a/blog/2024/02/20/remote-memory-profiling-with-memray/index.html b/blog/2024/02/20/remote-memory-profiling-with-memray/index.html
diff --git a/blog/archive/2022/index.html b/blog/archive/2022/index.html
diff --git a/blog/archive/2022/page/2/index.html b/blog/archive/2022/page/2/index.html
diff --git a/blog/archive/2023/index.html b/blog/archive/2023/index.html
diff --git a/blog/archive/2023/page/2/index.html b/blog/archive/2023/page/2/index.html
diff --git a/blog/archive/2023/page/3/index.html b/blog/archive/2023/page/3/index.html
diff --git a/blog/archive/2024/index.html b/blog/archive/2024/index.html
diff --git a/blog/category/devlog/index.html b/blog/category/devlog/index.html
diff --git a/blog/category/devlog/page/2/index.html b/blog/category/devlog/page/2/index.html
diff --git a/blog/category/news/index.html b/blog/category/news/index.html
diff --git a/blog/category/release/index.html b/blog/category/release/index.html
diff --git a/blog/category/release/page/2/index.html b/blog/category/release/page/2/index.html
diff --git a/blog/index.html b/blog/index.html
diff --git a/blog/page/2/index.html b/blog/page/2/index.html
diff --git a/blog/page/3/index.html b/blog/page/3/index.html
diff --git a/blog/page/4/index.html b/blog/page/4/index.html
diff --git a/css_types/border/index.html b/css_types/border/index.html
diff --git a/css_types/color/index.html b/css_types/color/index.html
diff --git a/css_types/horizontal/index.html b/css_types/horizontal/index.html
diff --git a/css_types/index.html b/css_types/index.html
diff --git a/css_types/integer/index.html b/css_types/integer/index.html
diff --git a/css_types/keyline/index.html b/css_types/keyline/index.html
diff --git a/css_types/name/index.html b/css_types/name/index.html
diff --git a/css_types/number/index.html b/css_types/number/index.html
diff --git a/css_types/overflow/index.html b/css_types/overflow/index.html
diff --git a/css_types/percentage/index.html b/css_types/percentage/index.html
diff --git a/css_types/scalar/index.html b/css_types/scalar/index.html
diff --git a/css_types/text_align/index.html b/css_types/text_align/index.html
diff --git a/css_types/text_style/index.html b/css_types/text_style/index.html
diff --git a/css_types/vertical/index.html b/css_types/vertical/index.html
diff --git a/events/blur/index.html b/events/blur/index.html
diff --git a/events/click/index.html b/events/click/index.html
diff --git a/events/descendant_blur/index.html b/events/descendant_blur/index.html
diff --git a/events/descendant_focus/index.html b/events/descendant_focus/index.html
diff --git a/events/enter/index.html b/events/enter/index.html
diff --git a/events/focus/index.html b/events/focus/index.html
diff --git a/events/hide/index.html b/events/hide/index.html
diff --git a/events/index.html b/events/index.html
diff --git a/events/key/index.html b/events/key/index.html
diff --git a/events/leave/index.html b/events/leave/index.html
diff --git a/events/load/index.html b/events/load/index.html
diff --git a/events/mount/index.html b/events/mount/index.html
diff --git a/events/mouse_capture/index.html b/events/mouse_capture/index.html
diff --git a/events/mouse_down/index.html b/events/mouse_down/index.html
diff --git a/events/mouse_move/index.html b/events/mouse_move/index.html
diff --git a/events/mouse_release/index.html b/events/mouse_release/index.html
diff --git a/events/mouse_scroll_down/index.html b/events/mouse_scroll_down/index.html
diff --git a/events/mouse_scroll_up/index.html b/events/mouse_scroll_up/index.html
diff --git a/events/mouse_up/index.html b/events/mouse_up/index.html
diff --git a/events/paste/index.html b/events/paste/index.html
diff --git a/events/resize/index.html b/events/resize/index.html
diff --git a/events/screen_resume/index.html b/events/screen_resume/index.html
diff --git a/events/screen_suspend/index.html b/events/screen_suspend/index.html
diff --git a/events/show/index.html b/events/show/index.html
diff --git a/examples/guide/animator/animation01_static.py b/examples/guide/animator/animation01_static.py
@@ -1,6 +1,9 @@
+from textual._easing import DEFAULT_EASING, EASING
 from textual.app import App, ComposeResult
 from textual.widgets import Static
 
+ease = EASING[DEFAULT_EASING]
+
 
 class AnimationApp(App):
     def compose(self) -> ComposeResult:
@@ -10,6 +13,15 @@ def compose(self) -> ComposeResult:
         self.box.styles.padding = (1, 2)
         yield self.box
 
+    def key_1(self):
+        self.box.styles.opacity = 1 - ease(0.25)
+
+    def key_2(self):
+        self.box.styles.opacity = 1 - ease(0.5)
+
+    def key_3(self):
+        self.box.styles.opacity = 1 - ease(0.75)
+
 
 if __name__ == "__main__":
     app = AnimationApp()

diff --git a/examples/guide/reactivity/recompose01.py b/examples/guide/reactivity/recompose01.py
@@ -0,0 +1,32 @@
+from datetime import datetime
+
+from textual.app import App, ComposeResult
+from textual.reactive import reactive
+from textual.widgets import Digits
+
+
+class Clock(App):
+
+    CSS = """
+    Screen {align: center middle}
+    Digits {width: auto}
+    """
+
+    time: reactive[datetime] = reactive(datetime.now, init=False)
+
+    def compose(self) -> ComposeResult:
+        yield Digits(f"{self.time:%X}")
+
+    def watch_time(self) -> None:  # (1)!
+        self.query_one(Digits).update(f"{self.time:%X}")
+
+    def update_time(self) -> None:
+        self.time = datetime.now()
+
+    def on_mount(self) -> None:
+        self.set_interval(1, self.update_time)  # (2)!
+
+
+if __name__ == "__main__":
+    app = Clock()
+    app.run()
diff --git a/examples/guide/reactivity/recompose02.py b/examples/guide/reactivity/recompose02.py
@@ -0,0 +1,29 @@
+from datetime import datetime
+
+from textual.app import App, ComposeResult
+from textual.reactive import reactive
+from textual.widgets import Digits
+
+
+class Clock(App):
+
+    CSS = """
+    Screen {align: center middle}
+    Digits {width: auto}
+    """
+
+    time: reactive[datetime] = reactive(datetime.now, recompose=True)
+
+    def compose(self) -> ComposeResult:
+        yield Digits(f"{self.time:%X}")
+
+    def update_time(self) -> None:
+        self.time = datetime.now()
+
+    def on_mount(self) -> None:
+        self.set_interval(1, self.update_time)
+
+
+if __name__ == "__main__":
+    app = Clock()
+    app.run()
diff --git a/examples/guide/reactivity/refresh03.py b/examples/guide/reactivity/refresh03.py
@@ -0,0 +1,29 @@
+from textual.app import App, ComposeResult
+from textual.reactive import reactive
+from textual.widget import Widget
+from textual.widgets import Input, Label
+
+
+class Name(Widget):
+    """Generates a greeting."""
+
+    who = reactive("name", recompose=True)  # (1)!
+
+    def compose(self) -> ComposeResult:  # (2)!
+        yield Label(f"Hello, {self.who}!")
+
+
+class WatchApp(App):
+    CSS_PATH = "refresh02.tcss"
+
+    def compose(self) -> ComposeResult:
+        yield Input(placeholder="Enter your name")
+        yield Name()
+
+    def on_input_changed(self, event: Input.Changed) -> None:
+        self.query_one(Name).who = event.value
+
+
+if __name__ == "__main__":
+    app = WatchApp()
+    app.run()
diff --git a/examples/guide/reactivity/refresh03.tcss b/examples/guide/reactivity/refresh03.tcss
@@ -0,0 +1,10 @@
+Input {
+    dock: top;
+    margin-top: 1;
+}
+
+Name {
+    width: auto;
+    height: auto;
+    border: heavy $secondary;
+}
diff --git a/examples/how-to/render_compose.py b/examples/how-to/render_compose.py
@@ -1,6 +1,6 @@
 from time import time
 
-from textual.app import App, ComposeResult, RenderableType
+from textual.app import App, ComposeResult, RenderResult
 from textual.containers import Container
 from textual.renderables.gradient import LinearGradient
 from textual.widgets import Static
@@ -41,7 +41,7 @@ def on_mount(self) -> None:
     def compose(self) -> ComposeResult:
         yield Static("Making a splash with Textual!")  # (2)!
 
-    def render(self) -> RenderableType:
+    def render(self) -> RenderResult:
         return LinearGradient(time() * 90, STOPS)  # (3)!