Merge pull request #4951 from Textualize/escape-minimize

Add classvar ESCAPE_TO_MINIMIZE

Author: willmcgugan

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - Added `DOMNode.check_consume_key` https://github.com/Textualize/textual/pull/4940
+- Added `App.ESCAPE_TO_MINIMIZE`, `App.screen_to_minimize`, and `Screen.ESCAPE_TO_MINIMIZE` https://github.com/Textualize/textual/pull/4951
 - Added `DOMNode.query_exactly_one` https://github.com/Textualize/textual/pull/4950
 - Added `SelectorSet.is_simple` https://github.com/Textualize/textual/pull/4950
 

src/textual/app.py

@@ -410,9 +410,18 @@ class MyApp(App[None]):
     """The time in seconds after which a tooltip gets displayed."""
 
     BINDING_GROUP_TITLE = "App"
+    """Shown in the key panel."""
+
+    ESCAPE_TO_MINIMIZE: ClassVar[bool] = True
+    """Use escape key to minimize widgets (potentially overriding bindings).
+    
+    This is the default value, used if the active screen's `ESCAPE_TO_MINIMIZE` is not changed from `None`.
+    """
 
     title: Reactive[str] = Reactive("", compute=False)
+    """The title of the app, displayed in the header."""
     sub_title: Reactive[str] = Reactive("", compute=False)
+    """The app's sub-title, combined with [`title`][textual.app.App.title] in the header."""
 
     dark: Reactive[bool] = Reactive(True, compute=False)
     """Use a dark theme if `True`, otherwise use a light theme.
@@ -3278,7 +3287,11 @@ async def on_event(self, event: events.Event) -> None:
             elif isinstance(event, events.Key):
                 # Special case for maximized widgets
                 # If something is maximized, then escape should minimize
-                if self.screen.maximized is not None and event.key == "escape":
+                if (
+                    self.screen.maximized is not None
+                    and event.key == "escape"
+                    and self.escape_to_minimize
+                ):
                     self.screen.minimize()
                     return
                 if self.focused:
@@ -3300,6 +3313,23 @@ async def on_event(self, event: events.Event) -> None:
         else:
             await super().on_event(event)
 
+    @property
+    def escape_to_minimize(self) -> bool:
+        """Use the escape key to minimize?
+
+        When a widget is [maximized][textual.screen.Screen.maximize], this boolean determines if the `escape` key will
+        minimize the widget (potentially overriding any bindings).
+
+        The default logic is to use the screen's `ESCAPE_TO_MINIMIZE` classvar if it is set to `True` or `False`.
+        If the classvar on the screen is *not* set (and left as `None`), then the app's `ESCAPE_TO_MINIMIZE` is used.
+
+        """
+        return bool(
+            self.ESCAPE_TO_MINIMIZE
+            if self.screen.ESCAPE_TO_MINIMIZE is None
+            else self.screen.ESCAPE_TO_MINIMIZE
+        )
+
     def _parse_action(
         self, action: str | ActionParseResult, default_namespace: DOMNode
     ) -> tuple[DOMNode, str, tuple[object, ...]]:
@@ -3336,7 +3366,6 @@ def _check_action_state(
         self, action: str, default_namespace: DOMNode
     ) -> bool | None:
         """Check if an action is enabled.
-
         Args:
             action: An action string.
 

src/textual/screen.py

@@ -191,6 +191,9 @@ class Screen(Generic[ScreenResultType], Widget):
     ALLOW_IN_MAXIMIZED_VIEW: ClassVar[str] = ".-textual-system,Footer"
     """A selector for the widgets (direct children of Screen) that are allowed in the maximized view (in addition to maximized widget)."""
 
+    ESCAPE_TO_MINIMIZE: ClassVar[bool | None] = None
+    """Use escape key to minimize (potentially overriding bindings) or `None` to defer to [`App.ESCAPE_TO_MINIMIZE`][textual.app.App.ESCAPE_TO_MINIMIZE]."""
+
     maximized: Reactive[Widget | None] = Reactive(None, layout=True)
     """The currently maximized widget, or `None` for no maximized widget."""