Added input_selection shortcut.

jonathanslenders · jonathanslenders · commit 52cd964f12c8 · 2025-08-26T11:08:42.000Z
diff --git a/examples/input_selection/color.py b/examples/input_selection/color.py
@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from prompt_toolkit.formatted_text import HTML
+from prompt_toolkit.shortcuts.input_selection import select_input
+from prompt_toolkit.styles import Style
+
+
+def main() -> None:
+    style = Style.from_dict(
+        {
+            "input-selection": "fg:#ff0000",
+            "number": "fg:#884444 bold",
+            "selected-option": "underline",
+            "frame.border": "#884444",
+        }
+    )
+
+    result = select_input(
+        message=HTML("<u>Please select a dish</u>:"),
+        options=[
+            ("pizza", "Pizza with mushrooms"),
+            (
+                "salad",
+                HTML("<ansigreen>Salad</ansigreen> with <ansired>tomatoes</ansired>"),
+            ),
+            ("sushi", "Sushi"),
+        ],
+        style=style,
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/input_selection/many-options.py b/examples/input_selection/many-options.py
@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from prompt_toolkit.shortcuts.input_selection import select_input
+
+
+def main() -> None:
+    result = select_input(
+        message="Please select an option:",
+        options=[(i, f"Option {i}") for i in range(1, 100)],
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/input_selection/simple-selection.py b/examples/input_selection/simple-selection.py
@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from prompt_toolkit.shortcuts.input_selection import select_input
+
+
+def main() -> None:
+    result = select_input(
+        message="Please select a dish:",
+        options=[
+            ("pizza", "Pizza with mushrooms"),
+            ("salad", "Salad with tomatoes"),
+            ("sushi", "Sushi"),
+        ],
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/input_selection/with-frame.py b/examples/input_selection/with-frame.py
@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from prompt_toolkit.filters import is_done
+from prompt_toolkit.formatted_text import HTML
+from prompt_toolkit.shortcuts.input_selection import select_input
+from prompt_toolkit.styles import Style
+
+
+def main() -> None:
+    style = Style.from_dict(
+        {
+            "frame.border": "#884444",
+            # Mark selected option in bold, when accepted:
+            "accepted selected-option": "bold",
+        }
+    )
+
+    result = select_input(
+        message=HTML("<u>Please select a dish</u>:"),
+        options=[
+            ("pizza", "Pizza with mushrooms"),
+            ("salad", "Salad with tomatoes"),
+            ("sushi", "Sushi"),
+        ],
+        style=style,
+        show_frame=~is_done,
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/src/prompt_toolkit/layout/containers.py b/src/prompt_toolkit/layout/containers.py
@@ -2603,8 +2603,18 @@ class ConditionalContainer(Container):
     :param filter: :class:`.Filter` instance.
     """
 
-    def __init__(self, content: AnyContainer, filter: FilterOrBool) -> None:
+    def __init__(
+        self,
+        content: AnyContainer,
+        filter: FilterOrBool,
+        alternative_content: AnyContainer | None = None,
+    ) -> None:
         self.content = to_container(content)
+        self.alternative_content = (
+            to_container(alternative_content)
+            if alternative_content is not None
+            else None
+        )
         self.filter = to_filter(filter)
 
     def __repr__(self) -> str:
@@ -2616,12 +2626,18 @@ def reset(self) -> None:
     def preferred_width(self, max_available_width: int) -> Dimension:
         if self.filter():
             return self.content.preferred_width(max_available_width)
+        elif self.alternative_content is not None:
+            return self.alternative_content.preferred_width(max_available_width)
         else:
             return Dimension.zero()
 
     def preferred_height(self, width: int, max_available_height: int) -> Dimension:
         if self.filter():
             return self.content.preferred_height(width, max_available_height)
+        elif self.alternative_content is not None:
+            return self.alternative_content.preferred_height(
+                width, max_available_height
+            )
         else:
             return Dimension.zero()
 
@@ -2638,9 +2654,21 @@ def write_to_screen(
             return self.content.write_to_screen(
                 screen, mouse_handlers, write_position, parent_style, erase_bg, z_index
             )
+        elif self.alternative_content is not None:
+            return self.alternative_content.write_to_screen(
+                screen,
+                mouse_handlers,
+                write_position,
+                parent_style,
+                erase_bg,
+                z_index,
+            )
 
     def get_children(self) -> list[Container]:
-        return [self.content]
+        result = [self.content]
+        if self.alternative_content is not None:
+            result.append(self.alternative_content)
+        return result
 
 
 class DynamicContainer(Container):
diff --git a/src/prompt_toolkit/shortcuts/input_selection.py b/src/prompt_toolkit/shortcuts/input_selection.py
@@ -0,0 +1,166 @@
+from __future__ import annotations
+
+from typing import Generic, Sequence, TypeVar
+
+from prompt_toolkit.application import Application
+from prompt_toolkit.filters import Condition, FilterOrBool, to_filter
+from prompt_toolkit.formatted_text import AnyFormattedText
+from prompt_toolkit.key_binding.key_bindings import KeyBindings
+from prompt_toolkit.key_binding.key_processor import KeyPressEvent
+from prompt_toolkit.layout import AnyContainer, ConditionalContainer, HSplit, Layout
+from prompt_toolkit.styles import BaseStyle
+from prompt_toolkit.utils import suspend_to_background_supported
+from prompt_toolkit.widgets import Box, Frame, Label, RadioList
+
+__all__ = [
+    "InputSelection",
+    "select_input",
+]
+
+_T = TypeVar("_T")
+E = KeyPressEvent
+
+
+class InputSelection(Generic[_T]):
+    def __init__(
+        self,
+        *,
+        message: AnyFormattedText,
+        options: Sequence[tuple[_T, AnyFormattedText]],
+        default: _T | None = None,
+        mouse_support: bool = True,
+        style: BaseStyle | None = None,
+        symbol: str = ">",
+        show_frame: FilterOrBool = False,
+        enable_suspend: FilterOrBool = False,
+        enable_abort: FilterOrBool = True,
+        interrupt_exception: type[BaseException] = KeyboardInterrupt,
+    ) -> None:
+        self.message = message
+        self.default = default
+        self.options = options
+        self.mouse_support = mouse_support
+        self.style = style
+        self.symbol = symbol
+        self.show_frame = show_frame
+        self.enable_suspend = enable_suspend
+        self.interrupt_exception = interrupt_exception
+        self.enable_abort = enable_abort
+
+    def _create_application(self) -> Application[_T]:
+        radio_list = RadioList(
+            values=self.options,
+            default=self.default,
+            select_on_focus=True,
+            open_character="",
+            select_character=self.symbol,
+            close_character="",
+            show_cursor=False,
+            show_numbers=True,
+            container_style="class:input-selection",
+            default_style="class:option",
+            selected_style="",
+            checked_style="class:selected-option",
+            number_style="class:number",
+            show_scrollbar=False,
+        )
+        container: AnyContainer = HSplit(
+            [
+                Box(
+                    Label(text=self.message, dont_extend_height=True),
+                    padding_top=0,
+                    padding_left=1,
+                    padding_right=1,
+                    padding_bottom=0,
+                ),
+                Box(
+                    radio_list,
+                    padding_top=0,
+                    padding_left=3,
+                    padding_right=1,
+                    padding_bottom=0,
+                ),
+            ]
+        )
+
+        @Condition
+        def show_frame_filter() -> bool:
+            return to_filter(self.show_frame)()
+
+        container = ConditionalContainer(
+            Frame(container),
+            alternative_content=container,
+            filter=show_frame_filter,
+        )
+
+        layout = Layout(container, radio_list)
+
+        kb = KeyBindings()
+
+        @kb.add("enter", eager=True)
+        def _accept_input(event: E) -> None:
+            "Accept input when enter has been pressed."
+            event.app.exit(result=radio_list.current_value, style="class:accepted")
+
+        @Condition
+        def enable_abort() -> bool:
+            return to_filter(self.enable_abort)()
+
+        @kb.add("c-c", filter=enable_abort)
+        @kb.add("<sigint>", filter=enable_abort)
+        def _keyboard_interrupt(event: E) -> None:
+            "Abort when Control-C has been pressed."
+            event.app.exit(exception=self.interrupt_exception(), style="class:aborting")
+
+        suspend_supported = Condition(suspend_to_background_supported)
+
+        @Condition
+        def enable_suspend() -> bool:
+            return to_filter(self.enable_suspend)()
+
+        @kb.add("c-z", filter=suspend_supported & enable_suspend)
+        def _suspend(event: E) -> None:
+            """
+            Suspend process to background.
+            """
+            event.app.suspend_to_background()
+
+        return Application(
+            layout=layout,
+            full_screen=False,
+            mouse_support=self.mouse_support,
+            key_bindings=kb,
+            style=self.style,
+        )
+
+    def prompt(self) -> _T:
+        return self._create_application().run()
+
+    async def prompt_async(self) -> _T:
+        return await self._create_application().run_async()
+
+
+def select_input(
+    message: AnyFormattedText,
+    options: Sequence[tuple[_T, AnyFormattedText]],
+    default: _T | None = None,
+    mouse_support: bool = True,
+    style: BaseStyle | None = None,
+    symbol: str = ">",
+    show_frame: bool = False,
+    enable_suspend: FilterOrBool = False,
+    enable_abort: FilterOrBool = True,
+    interrupt_exception: type[BaseException] = KeyboardInterrupt,
+) -> _T:
+    return InputSelection[_T](
+        message=message,
+        options=options,
+        default=default,
+        mouse_support=mouse_support,
+        style=style,
+        symbol=symbol,
+        show_frame=show_frame,
+        enable_suspend=enable_suspend,
+        enable_abort=enable_abort,
+        interrupt_exception=interrupt_exception,
+    ).prompt()
diff --git a/src/prompt_toolkit/shortcuts/prompt.py b/src/prompt_toolkit/shortcuts/prompt.py
@@ -502,7 +502,9 @@ def _create_default_buffer(self) -> Buffer:
         def accept(buff: Buffer) -> bool:
             """Accept the content of the default buffer. This is called when
             the validation succeeds."""
-            cast(Application[str], get_app()).exit(result=buff.document.text)
+            cast(Application[str], get_app()).exit(
+                result=buff.document.text, style="class:accepted"
+            )
             return True  # Keep text, we call 'reset' later on.
 
         return Buffer(
diff --git a/src/prompt_toolkit/widgets/base.py b/src/prompt_toolkit/widgets/base.py
