Merge branch 'main' into allow-custom-local-app-names-testing

Author: schloerke

CHANGELOG.md

@@ -16,22 +16,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   * Add a `data-suggestion` attribute to an HTML element, and set the value to the input suggestion text (e.g., `<span data-suggestion="Suggestion value">Suggestion link</span>`)
   * To auto-submit the suggestion when clicked by the user, include the `.submit` class or the `data-suggestion-submit="true"` attribute on the HTML element. Alternatively, use Cmd/Ctrl + click to auto-submit any suggestion or Alt/Opt + click to apply any suggestion to the chat input without submitting.
 
-* Added a new `.add_sass_layer_file()` method to `ui.Theme` that supports reading a Sass file with layer boundary comments, e.g. `/*-- scss:defaults --*/`. This format [is supported by Quarto](https://quarto.org/docs/output-formats/html-themes-more.html#bootstrap-bootswatch-layering) and makes it easier to store Sass rules and declarations that need to be woven into Shiny's Sass Bootstrap files. (#1790)
-
-* The `ui.Chat()` component gains the following:
+* The `ui.Chat()` component also gains the following:
     * The `.on_user_submit()` decorator method now passes the user input to the decorated function. This makes it a bit easier to access the user input. See the new templates (mentioned below) for examples. (#1801)
+    * The assistant icon is now configurable via `ui.chat_ui()` (or the `ui.Chat.ui()` method in Shiny Express) or for individual messages in the `.append_message()` and `.append_message_stream()` methods of `ui.Chat()`. (#1853)
     * A new `get_latest_stream_result()` method was added for an easy way to access the final result of the stream when it completes. (#1846)
     * The `.append_message_stream()` method now returns the `reactive.extended_task` instance that it launches. (#1846)
+    * The `ui.Chat()` component's `.update_user_input()` method gains `submit` and `focus` options that allow you to submit the input on behalf of the user and to choose whether the input receives focus after the update. (#1851)
 
 * `shiny create` includes new and improved `ui.Chat()` template options. Most of these templates leverage the new [`{chatlas}` package](https://posit-dev.github.io/chatlas/), our opinionated approach to interfacing with various LLM. (#1806)
 
 * Client data values (e.g., url info, output sizes/styles, etc.) can now be accessed in the server-side Python code via `session.clientdata`. For example, `session.clientdata.url_search()` reactively reads the URL search parameters. (#1832)
 
 * Available `input` ids can now be listed via `dir(input)`. This also works on the new `session.clientdata` object. (#1832)
 
-* The `ui.Chat()` component's `.update_user_input()` method gains `submit` and `focus` options that allow you to submit the input on behalf of the user and to choose whether the input receives focus after the update. (#1851)
+* Added a new `.add_sass_layer_file()` method to `ui.Theme` that supports reading a Sass file with layer boundary comments, e.g. `/*-- scss:defaults --*/`. This format [is supported by Quarto](https://quarto.org/docs/output-formats/html-themes-more.html#bootstrap-bootswatch-layering) and makes it easier to store Sass rules and declarations that need to be woven into Shiny's Sass Bootstrap files. (#1790)
 
-* The assistant icons is now configurable via `ui.chat_ui()` (or the `ui.Chat.ui()` method in Shiny Express) or for individual messages in the `.append_message()` and `.append_message_stream()` methods of `ui.Chat()`. (#1853)
+* `ui.input_text()`, `ui.input_text_area()`, `ui.input_numeric()` and `ui.input_password()` all gain an `update_on` option. `update_on="change"` is the default and previous behavior, where the input value updates immediately whenever the value changes. With `update_on="blur"`, the input value will update only when the text input loses focus or when the user presses Enter (or Cmd/Ctrl + Enter for `ui.input_text_area()`). (#1874)
 
 * `shiny.pytest.create_app_fixture(app)` gained support for multiple app file paths when creating your test fixture. If multiple file paths are given, it will behave as a parameterized fixture value and execute the test for each app path. (#1869)
 

README.md

@@ -58,7 +58,7 @@ git fetch --tags upstream
 Then install:
 
 ```sh
-pip install -e ".[dev,test]"
+pip install -e ".[dev,test,doc]"
 ```
 
 Additionally, you can install pre-commit hooks which will automatically reformat and lint the code when you make a commit:
@@ -69,3 +69,29 @@ pre-commit install
 # To disable:
 # pre-commit uninstall
 ```
+
+Tests should now pass:
+
+```sh
+make check
+# To apply formatting fixes instead of erroring:
+# make check-fix
+```
+
+Or get a full list of helpers with just:
+
+```sh
+make
+```
+
+Typically, when developing new features for Shiny, you'll want to try them out in an application.
+In a **separate** application directory, use can use `-e` to reference your local checkout of `py-shiny`:
+
+```sh
+# Rather than
+#   pip install shiny
+# run:
+pip install -e ../py-shiny --config-settings editable_mode=compat
+```
+
+See the [docs README](docs/README.md) for instructions on building the documentation locally.

docs/README.md

@@ -5,7 +5,7 @@ This directory contains files to generate Shiny for Python API documentation, us
 
 ## Building the docs
 
-To build the docs, first install the Python dependencies and Quarto extensions:
+To build the docs, first [download and install Quarto](https://quarto.org/docs/get-started/), and then install the Python dependencies and Quarto extensions:
 
 ```bash
 # Install build dependencies
@@ -18,14 +18,14 @@ After those dependencies are installed, build the .qmd files for Shiny, using qu
 make quartodoc
 ```
 
-Then build the web site using Quarto:
+Then you can build the docs, and serve them locally, and watch for changes to the .qmd files:
 
 ```bash
-make site
+make serve
 ```
 
-Alternatively, running `make serve` will build the docs, and serve them locally, and watch for changes to the .qmd files:
+Alternatively, build the site just once:
 
 ```bash
-make serve
+make site
 ```

docs/_quartodoc-testing.yml

@@ -24,6 +24,7 @@ quartodoc:
     - title: UI Inputs
       desc: Methods for interacting with Shiny app input value controller.
       contents:
+        - playwright.controller.InputActionButton
         - playwright.controller.InputActionLink
         - playwright.controller.InputCheckbox
         - playwright.controller.InputCheckboxGroup

pyproject.toml

@@ -50,10 +50,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-theme = [
-    "libsass>=0.23.0",
-    "brand_yml>=0.1.0"
-]
+theme = ["libsass>=0.23.0", "brand_yml>=0.1.0"]
 test = [
     "pytest>=6.2.4",
     "pytest-asyncio>=0.17.2",
@@ -103,7 +100,7 @@ dev = [
     "isort>=5.10.1",
     "libsass>=0.23.0",
     "brand_yml>=0.1.0",
-    "pyright>=1.1.383",
+    "pyright>=1.1.383,<1.1.395",
     "pre-commit>=2.15.0",
     "wheel",
     "matplotlib",
@@ -158,7 +155,16 @@ ignore = ["E302", "E501", "F403", "F405", "W503", "E203", "E701", "E704"]
 
 [tool.isort]
 profile = "black"
-skip = ["__init__.py", "typings/", "_dev/", ".venv", "venv", ".tox", "build", "_version.py"]
+skip = [
+    "__init__.py",
+    "typings/",
+    "_dev/",
+    ".venv",
+    "venv",
+    ".tox",
+    "build",
+    "_version.py",
+]
 
 [tool.mypy]
 # The goal of our usage of mypy is to make to sure mypy can run, not that it catches any errors (we use pyright to find our errors).

scripts/_pkg-sources.R

@@ -1,6 +1,6 @@
 list(
-  bslib = "rstudio/bslib@b54bfb5de82f76bc044c4c661995af3a63e7ab29",
-  shiny = "rstudio/shiny@c489fef4ff46fc37eb2a7c447a7108afde7ad124",
+  bslib = "rstudio/bslib@main",
+  shiny = "rstudio/shiny@main",
   sass = "sass",
   htmltools = "rstudio/htmltools@main"
 )

shiny/_versions.py

@@ -1,5 +1,5 @@
-shiny_html_deps = "1.9.1.9000"
-bslib = "0.8.0.9000"
+shiny_html_deps = "1.10.0.9000"
+bslib = "0.9.0.9000"
 htmltools = "0.5.8.9000"
 bootstrap = "5.3.1"
 requirejs = "2.3.6"

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(