cleanup.

Author: jonathanslenders

examples/input_selection/default.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from prompt_toolkit.formatted_text import HTML
+from prompt_toolkit.shortcuts import select_input
+
+
+def main() -> None:
+    result = select_input(
+        message=HTML("<u>Please select a dish</u>:"),
+        options=[
+            ("pizza", "Pizza with mushrooms"),
+            ("salad", "Salad with tomatoes"),
+            ("sushi", "Sushi"),
+        ],
+        default="salad",
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()

examples/input_selection/mouse-support.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from prompt_toolkit.formatted_text import HTML
+from prompt_toolkit.shortcuts import select_input
+
+
+def main() -> None:
+    result = select_input(
+        message=HTML("<u>Please select a dish</u>:"),
+        options=[
+            ("pizza", "Pizza with mushrooms"),
+            ("salad", "Salad with tomatoes"),
+            ("sushi", "Sushi"),
+        ],
+        mouse_support=True,
+    )
+    print(result)
+
+
+if __name__ == "__main__":
+    main()

examples/input_selection/with-frame.py

@@ -22,6 +22,9 @@ def main() -> None:
             ("sushi", "Sushi"),
         ],
         style=style,
+        # Use `~is_done`, if you only want to show the frame while editing and
+        # hide it when the input is accepted.
+        # Use `True`, if you always want to show the frame.
         show_frame=~is_done,
     )
     print(result)

src/prompt_toolkit/shortcuts/input_selection.py

@@ -31,13 +31,37 @@ def create_default_input_selection_style() -> BaseStyle:
 
 
 class InputSelection(Generic[_T]):
+    """
+    Input selection prompt. Ask the user to choose among a set of options.
+
+    Example usage::
+
+        input_selection = InputSelection(
+            message="Please select a dish:",
+            options=[
+                ("pizza", "Pizza with mushrooms"),
+                ("salad", "Salad with tomatoes"),
+                ("sushi", "Sushi"),
+            ],
+            default="pizza",
+        )
+        result = input_selection.prompt()
+
+    :param message: Plain text or formatted text to be shown before the options.
+    :param options: Sequence of `(value, label)` tuples.
+    :param default: Default value. If none is given, the first option is
+        considered the default.
+    :param mouse_support: Enable mouse support.
+    :param style: :class:`.Style` instance for the color scheme.
+    """
+
     def __init__(
         self,
         *,
         message: AnyFormattedText,
         options: Sequence[tuple[_T, AnyFormattedText]],
         default: _T | None = None,
-        mouse_support: bool = True,
+        mouse_support: bool = False,
         style: BaseStyle | None = None,
         symbol: str = ">",
         show_frame: FilterOrBool = False,
@@ -156,14 +180,37 @@ def select_input(
     message: AnyFormattedText,
     options: Sequence[tuple[_T, AnyFormattedText]],
     default: _T | None = None,
-    mouse_support: bool = True,
+    mouse_support: bool = False,
     style: BaseStyle | None = None,
     symbol: str = ">",
     show_frame: bool = False,
     enable_suspend: FilterOrBool = False,
     enable_abort: FilterOrBool = True,
     interrupt_exception: type[BaseException] = KeyboardInterrupt,
 ) -> _T:
+    """
+    Input selection prompt. Ask the user to choose among a set of options.
+
+    Example usage::
+
+        result= select_input(
+            message="Please select a dish:",
+            options=[
+                ("pizza", "Pizza with mushrooms"),
+                ("salad", "Salad with tomatoes"),
+                ("sushi", "Sushi"),
+            ],
+            default="pizza",
+        )
+
+    :param message: Plain text or formatted text to be shown before the options.
+    :param options: Sequence of `(value, label)` tuples.
+    :param default: Default value. If none is given, the first option is
+        considered the default.
+    :param mouse_support: Enable mouse support.
+    :param style: :class:`.Style` instance for the color scheme.
+    """
+
     return InputSelection[_T](
         message=message,
         options=options,