module-attribute
+
+¶
- Bases: Exception
Signature for callbacks used in get_system_commands
+ Bases: Exception
class-attribute
+
+
+¶BINDINGS = [
+ Binding(
+ "ctrl+c", "quit", "Quit", show=False, priority=True
+ )
+]
+The default key bindings.
+COMMANDS = {get_system_commands}
+COMMANDS = {get_system_commands_provider}
@@ -11602,6 +11907,52 @@
+
+class-attribute
+
+
+¶
+
+
+
+
+ The key that launches the command palette (if enabled by App.ENABLE_COMMAND_PALETTE).
+
+
+
+
+
+
+
+
+
+class-attribute
+
+
+¶
+
+
+
+
+ How the command palette key should be displayed in the footer (or None for default).
+
+
+
+
+
+
+
+
+
+class-attribute
+ instance-attribute
+
+
+¶
+
+
+
+
+ The time in seconds after which a tooltip gets displayed.
+
+
+
+
+
+
+
+
- Active binding information
+ A dict that maps keys on to binding information.
@@ -13043,6 +13418,25 @@
+
+
+
+
+
+
+ Hide the keys panel (if present).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Show the keys panel.
+
+
+
+
+
+
+
+
base_screen
¶
- str | Screen | Callable[[], Screen]
+ str | Callable[[], Screen]
@@ -14874,17 +15287,16 @@
¶
-get_key_display(key)
+get_key_display(binding)
- For a given key, return how it should be displayed in an app
-(e.g. in the Footer widget).
-By key, we refer to the string used in the "key" argument for
-a Binding instance. By overriding this method, you can ensure that
-keys are displayed consistently throughout your app, without
-needing to add a key_display to every binding.
+ Format a bound key for display in footer / key panel etc.
+
+Note
+You can implement this in a subclass if you want to change how keys are displayed in your app.
+
Parameters:
@@ -14900,14 +15312,14 @@
- key
-¶
+ binding
+¶
- str
+ Binding
- The binding key string.
+ A Binding.
@@ -14933,7 +15345,7 @@
-
The display string for the input key.
+ A string used to represent the key.
@@ -15086,6 +15498,89 @@
+
+
+get_system_commands(screen)
+
+
+
+
+ A generator of system commands used in the command palette.
+
+
+Parameters:
+
+
+
+ Name
+ Type
+ Description
+ Default
+
+
+
+
+
+ screen
+¶
+
+ Screen
+
+
+
+ The screen where the command palette was invoked from.
+
+
+
+ required
+
+
+
+
+ Implement this method in your App subclass if you want to add custom commands.
+Here is an example:
+def get_system_commands(self) -> Iterable[SystemCommand]:
+ yield from super().get_system_commands()
+ yield SystemCommand("Bell", "Ring the bell", self.bell)
+
+
+Note
+Requires that SystemCommandsProvider is in App.COMMANDS class variable.
+
+
+
+ Yields:
+
+
+
+ Type
+ Description
+
+
+
+
+
+ Iterable[SystemCommand]
+
+
+
+ SystemCommand instances.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bases: NamedTuple
+
+
+
+ Defines a system command used in the command palette (yielded from get_system_commands).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+instance-attribute
+
+
+¶
+
+
+
+
+ A callback to invoke when the command is selected.
+
+
+
+
+
+
+
+
+
+class-attribute
+ instance-attribute
+
+
+¶
+
+
+
+
+ Should the command show when the search is empty?
+
+
+
+
+
+
+
+
+
+instance-attribute
+
+
+¶
+
+
+
+
+ Additional help text, shown under the title.
+
+
+
+
+
+
+
+
+
+instance-attribute
+
+
+¶
+
+
+
+
+ The title of the command (used in search).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
-get_system_commands()
+¶
+
@@ -18142,7 +18775,7 @@
- type[SystemCommands]
+ type[SystemCommandsProvider]
diff --git a/api/await_complete/index.html b/api/await_complete/index.html
index 34029e9d88..9c0a83c649 100644
--- a/api/await_complete/index.html
+++ b/api/await_complete/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/await_remove/index.html b/api/await_remove/index.html
index 42ae0f4a57..62531d72d2 100644
--- a/api/await_remove/index.html
+++ b/api/await_remove/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/binding/index.html b/api/binding/index.html
index e2cab426d1..3c4396702a 100644
--- a/api/binding/index.html
+++ b/api/binding/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5058,6 +5035,15 @@
+
+
+
+
+
+
@@ -5127,6 +5113,24 @@
+
+
+
+
+
+
+
+
+
+
+
@@ -6753,6 +6757,15 @@
+
+
+
+
+
+
@@ -6822,6 +6835,24 @@
+
+
+
+
+
+
+
+
+
+
+
@@ -7189,6 +7220,30 @@
+
+
+
+
+
+class-attribute
+ instance-attribute
+
+
+¶
+
+
+
+
+ Optional tooltip shown in Footer.
+
+
+
+
@@ -7219,7 +7274,8 @@
show=True,
key_display=None,
priority=False,
-)
+ tooltip="",
+)
@@ -7386,7 +7442,73 @@
+
+
+
+
+
+class-attribute
+ instance-attribute
+
+
+¶
+
+
+
+
+ Optional tooltip to show in footer.
+
+
+
+
+
+
diff --git a/api/cache/index.html b/api/cache/index.html
index 4e51b546da..77087cfebd 100644
--- a/api/cache/index.html
+++ b/api/cache/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/color/index.html b/api/color/index.html
index 3c8f07bd01..71cf8b8c30 100644
--- a/api/color/index.html
+++ b/api/color/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/command/index.html b/api/command/index.html
index d9db51849f..51643a0c0c 100644
--- a/api/command/index.html
+++ b/api/command/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/constants/index.html b/api/constants/index.html
index 01d10e83cc..5d8d627dd3 100644
--- a/api/constants/index.html
+++ b/api/constants/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/containers/index.html b/api/containers/index.html
index 89d5cf117c..2aeb164148 100644
--- a/api/containers/index.html
+++ b/api/containers/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/coordinate/index.html b/api/coordinate/index.html
index 8a6945ab61..57a53864c1 100644
--- a/api/coordinate/index.html
+++ b/api/coordinate/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/api/dom_node/index.html b/api/dom_node/index.html
index 1d5c52b22c..e10c0cb942 100644
--- a/api/dom_node/index.html
+++ b/api/dom_node/index.html
@@ -3891,8 +3891,6 @@
-
-
@@ -4035,27 +4033,6 @@
-
-
-
-
-
- ClassicFooter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5207,6 +5184,24 @@