Merge branch 'main' into add-missing-controller-method

Author: karangattu

.github/workflows/pytest.yaml

@@ -154,7 +154,7 @@ jobs:
 
   playwright-examples:
     if: github.event_name != 'release'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ["3.12", "3.11", "3.10", "3.9"]

.github/workflows/verify-js-built.yaml

@@ -39,7 +39,7 @@ jobs:
         run: |
           if [[ `git status --porcelain` ]]; then
             git diff
-            echo "Uncommitted changes found. Please commit any changes that result from 'npm run build'."
+            echo "Uncommitted changes found. Please commit any changes that result from 'npm ci && npm run build'."
             exit 1
           else
             echo "No uncommitted changes found."

CHANGELOG.md

@@ -9,20 +9,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### New features
 
-* 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)
+* Added a new `ui.MarkdownStream()` component for performantly streaming in chunks of markdown/html strings into the UI. This component is primarily useful for text-based generative AI where responses are received incrementally. (#1782)
+
+* The `ui.Chat()` component now supports input suggestion links. This feature is useful for providing users with clickable suggestions that can be used to quickly input text into the chat. This can be done in 2 different ways (see #1845 for more details):
+  * By adding a `.suggestion` CSS class to an HTML element (e.g., `<span class="suggestion">A suggestion</span>`)
+  * 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.
 
-* The `ui.Chat()` component's `.on_user_submit()` decorator method now passes the user input to the decorated function. This makes it a bit more obvious how to access the user input inside the decorated function. See the new templates (mentioned below) for examples. (#1801)
+* 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)
 
 * Added a new `expect_max_height()` method to the Valuebox controllers to check the maximum height of a value box (#1816)
 
+* 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)
+
+* 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)
+
+* `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)
+
 ### Bug fixes
 
 * `ui.Chat()` now correctly handles new `ollama.chat()` return value introduced in `ollama` v0.4. (#1787)
 
 * Updated `expect_height()` for Valuebox controllers to check the height property instead of max-height. (#1816)
 
+### Changes
+
+* The Shiny Core component `shiny.ui.Chat()` no longer has a `.ui()` method. This method
+was never intended to be used in Shiny Core (in that case, use `shiny.ui.chat_ui()`) to create the UI element. Note that the `shiny.express.ui.Chat()`
+class still has a `.ui()` method. (#1840)
+
 ## [1.2.1] - 2024-11-14
 
 ### Bug fixes

README.md

@@ -24,7 +24,7 @@ If you have questions about Shiny for Python, or want to help us decide what to
 
 ## Getting started
 
-To get started with shiny follow the [installation instructions](https://shiny.posit.co/py/docs/install.html) or just install it from pip.
+To get started with shiny follow the [installation instructions](https://shiny.posit.co/py/docs/install-create-run.html) or just install it from pip.
 
 ```sh
 pip install shiny
@@ -47,10 +47,18 @@ You can create and run your first application with `shiny create`, the CLI will
     * https://posit-dev.github.io/py-shiny/docs/api/express/
     * https://posit-dev.github.io/py-shiny/docs/api/core/
 
-If you want to do development on Shiny for Python:
+If you are working from a fork you may not have the git tags from the original repo.
+Git tags are required for the install to succeed. To add tags to your own fork:
 
 ```sh
-pip install -e ".[dev,test]"
+git remote add upstream https://github.com/posit-dev/py-shiny.git
+git fetch --tags upstream
+```
+
+Then install:
+
+```sh
+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:
@@ -61,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-core.yml

@@ -102,6 +102,11 @@ quartodoc:
       contents:
         - ui.Chat
         - ui.chat_ui
+    - title: Streaming markdown
+      desc: Stream markdown content into the UI
+      contents:
+        - ui.MarkdownStream
+        - ui.output_markdown_stream
     - title: Custom UI
       desc: Lower-level UI functions for creating custom HTML/CSS/JS
       contents:
@@ -228,19 +233,21 @@ quartodoc:
           path: Session
           summary:
             name: "Session"
-            desc: ""
+            desc: "Tools for managing user sessions and accessing session-related information."
           flatten: true
           contents:
             - session.get_current_session
             - session.require_active_session
             - session.session_context
             - reactive.get_current_context
+            - session.ClientData
             - session.Session.send_custom_message
             - session.Session.send_input_message
             - session.Session.on_flush
             - session.Session.on_flushed
             - session.Session.on_ended
             - session.Session.dynamic_route
+            - session.Session.close
             - input_handler.input_handlers
         - kind: page
           path: Renderer
@@ -358,4 +365,3 @@ quartodoc:
           contents:
             - name: experimental.ui.card_image
               dynamic: false
-

docs/_quartodoc-express.yml

@@ -81,6 +81,10 @@ quartodoc:
       desc: Build a chatbot interface
       contents:
         - express.ui.Chat
+    - title: Streaming markdown
+      desc: Stream markdown content into the UI
+      contents:
+        - express.ui.MarkdownStream
     - title: Reactive programming
       desc: Create reactive functions and dependencies.
       contents:
@@ -164,6 +168,14 @@ quartodoc:
         - express.ui.panel_conditional
         - express.ui.insert_ui
         - express.ui.remove_ui
+    - title: User Session
+      desc: Tools for managing user sessions and accessing session-related information.
+      contents:
+        - session.Session
+    - title: Client Data
+      desc: Access (client-side) information about the user session (e.g., URL, output info, etc).
+      contents:
+        - session.ClientData
     - title: UI as HTML
       desc: Tools for creating HTML/CSS/JS
       contents:

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

js/build.ts

@@ -74,6 +74,20 @@ const opts: Array<BuildOptions> = [
     plugins: [sassPlugin({ type: "css", sourceMap: false })],
     metafile: true,
   },
+  {
+    entryPoints: {
+      "markdown-stream/markdown-stream": "markdown-stream/markdown-stream.ts",
+    },
+    minify: true,
+    sourcemap: true,
+  },
+  {
+    entryPoints: {
+      "markdown-stream/markdown-stream": "markdown-stream/markdown-stream.scss",
+    },
+    plugins: [sassPlugin({ type: "css", sourceMap: false })],
+    metafile: true,
+  },
   {
     entryPoints: {
       "chat/chat": "chat/chat.ts",