feat: Add update_on parameter to ui.input_{text,text_area,numeric,password}

Author: gadenbuie

shiny/ui/_input_numeric.py

@@ -1,6 +1,6 @@
 __all__ = ("input_numeric",)
 
-from typing import Optional
+from typing import Literal, Optional
 
 from htmltools import Tag, TagChild, css, div, tags
 
@@ -19,6 +19,7 @@ def input_numeric(
     max: Optional[float] = None,
     step: Optional[float] = None,
     width: Optional[str] = None,
+    update_on: Literal["change", "blur"] = "change",
 ) -> Tag:
     """
     Create an input control for entry of numeric values.
@@ -39,6 +40,11 @@ def input_numeric(
         Interval to use when stepping between min and max.
     width
         The CSS width, e.g. '400px', or '100%'
+    update_on
+        When should the input value be updated? Options are `"change"` (default) and
+        `"blur"`. Use `"change"` to update the input immediately whenever the value
+        changes. Use `"blur"`to delay the input update until the input loses focus (the
+        user moves away from the input), or when Enter is pressed.
 
     Returns
     -------
@@ -67,6 +73,7 @@ def input_numeric(
             min=min,
             max=max,
             step=step,
+            data_update_on=update_on,
         ),
         class_="form-group shiny-input-container",
         style=css(width=width),

shiny/ui/_input_password.py

@@ -1,6 +1,6 @@
 __all__ = ("input_password",)
 
-from typing import Optional
+from typing import Literal, Optional
 
 from htmltools import Tag, TagChild, css, div, tags
 
@@ -17,6 +17,7 @@ def input_password(
     *,
     width: Optional[str] = None,
     placeholder: Optional[str] = None,
+    update_on: Literal["change", "blur"] = "change",
 ) -> Tag:
     """
     Create an password control for entry of passwords.
@@ -33,6 +34,11 @@ def input_password(
         The CSS width, e.g., '400px', or '100%'.
     placeholder
         The placeholder of the input.
+    update_on
+        When should the input value be updated? Options are `"change"` (default) and
+        `"blur"`. Use `"change"` to update the input immediately whenever the value
+        changes. Use `"blur"`to delay the input update until the input loses focus (the
+        user moves away from the input), or when Enter is pressed.
 
     Returns
     -------
@@ -58,6 +64,7 @@ def input_password(
             value=value,
             class_="shiny-input-password form-control",
             placeholder=placeholder,
+            data_update_on=update_on,
         ),
         class_="form-group shiny-input-container",
         style=css(width=width),

shiny/ui/_input_text.py

@@ -20,6 +20,7 @@ def input_text(
     placeholder: Optional[str] = None,
     autocomplete: Optional[str] = "off",
     spellcheck: Optional[Literal["true", "false"]] = None,
+    update_on: Literal["change", "blur"] = "change",
 ) -> Tag:
     """
     Create an input control for entry of text values.
@@ -45,6 +46,11 @@ def input_text(
     spellcheck
         Whether to enable browser spell checking of the text input (default is ``None``). If
         None, then it will use the browser's default behavior.
+    update_on
+        When should the input value be updated? Options are `"change"` (default) and
+        `"blur"`. Use `"change"` to update the input immediately whenever the value
+        changes. Use `"blur"`to delay the input update until the input loses focus (the
+        user moves away from the input), or when Enter is pressed.
 
     Returns
     -------
@@ -74,6 +80,7 @@ def input_text(
             placeholder=placeholder,
             autocomplete=autocomplete,
             spellcheck=spellcheck,
+            data_update_on=update_on,
         ),
         class_="form-group shiny-input-container",
         style=css(width=width),
@@ -95,6 +102,7 @@ def input_text_area(
     autoresize: bool = False,
     autocomplete: Optional[str] = None,
     spellcheck: Optional[Literal["true", "false"]] = None,
+    update_on: Literal["change", "blur"] = "change",
 ) -> Tag:
     """
     Create a textarea input control for entry of unstructured text values.
@@ -137,6 +145,11 @@ def input_text_area(
     spellcheck
         Whether to enable browser spell checking of the text input (default is ``None``). If
         None, then it will use the browser's default behavior.
+    update_on
+        When should the input value be updated? Options are `"change"` (default) and
+        `"blur"`. Use `"change"` to update the input immediately whenever the value
+        changes. Use `"blur"`to delay the input update until the input loses focus (the
+        user moves away from the input), or when Ctrl/Cmd + Enter is pressed.
 
     Returns
     -------
@@ -176,6 +189,7 @@ def input_text_area(
         cols=cols,
         autocomplete=autocomplete,
         spellcheck=spellcheck,
+        data_update_on=update_on,
     )
 
     return div(

tests/playwright/shiny/inputs/input_text_update_on/app.py

@@ -134,8 +134,13 @@ def _():
 
 app_ui = ui.page_fluid(
     ui.row(
-        ui.column(6, ui.div({"class": "col-sm-12"}, text_input_ui("change"))),
-        ui.column(6, ui.div({"class": "col-sm-12"}, text_input_ui("blur"))),
+        ui.column(
+            6,
+            ui.div({"class": "col-sm-12"}, text_input_ui("change", update_on="change")),
+        ),
+        ui.column(
+            6, ui.div({"class": "col-sm-12"}, text_input_ui("blur", update_on="blur"))
+        ),
     )
 )