Rename parameters back to bookmark_store and bookmark_on

schloerke · schloerke · commit f51c0be99efe · 2025-04-02T15:15:35.000-04:00
diff --git a/shiny/templates/chat/llm-enterprise/aws-bedrock-anthropic/app.py b/shiny/templates/chat/llm-enterprise/aws-bedrock-anthropic/app.py
@@ -29,7 +29,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Define a callback to run when the user submits a message
diff --git a/shiny/templates/chat/llm-enterprise/azure-openai/app.py b/shiny/templates/chat/llm-enterprise/azure-openai/app.py
@@ -34,7 +34,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Define a callback to run when the user submits a message
diff --git a/shiny/templates/chat/llms/anthropic/app.py b/shiny/templates/chat/llms/anthropic/app.py
@@ -34,7 +34,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Generate a response when the user submits a message
diff --git a/shiny/templates/chat/llms/google/app.py b/shiny/templates/chat/llms/google/app.py
@@ -30,7 +30,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Generate a response when the user submits a message
diff --git a/shiny/templates/chat/llms/langchain/app.py b/shiny/templates/chat/llms/langchain/app.py
@@ -35,7 +35,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Define a callback to run when the user submits a message
diff --git a/shiny/templates/chat/llms/ollama/app.py b/shiny/templates/chat/llms/ollama/app.py
@@ -26,7 +26,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Generate a response when the user submits a message
diff --git a/shiny/templates/chat/llms/openai/app.py b/shiny/templates/chat/llms/openai/app.py
@@ -34,7 +34,7 @@
 chat.ui()
 
 # Store chat state in the url when an "assistant" response occurs
-chat.enable_bookmarking(chat_client, store="url")
+chat.enable_bookmarking(chat_client, bookmark_store="url")
 
 
 # Generate a response when the user submits a message
diff --git a/shiny/ui/_chat.py b/shiny/ui/_chat.py
@@ -1416,7 +1416,7 @@ def enable_bookmarking(
         client: ClientWithState | chatlas.Chat[Any, Any],
         /,
         *,
-        on: Optional[Literal["response"]] = "response",
+        bookmark_on: Optional[Literal["response"]] = "response",
     ) -> CancelCallback:
         """
         Enable bookmarking for the chat instance.
@@ -1432,11 +1432,11 @@ def enable_bookmarking(
             The chat client instance to use for bookmarking. This can be a Chat model
             provider from [chatlas](https://posit-dev.github.io/chatlas/), or more
             generally, an instance following the `ClientWithState` protocol.
-        on
+        bookmark_on
             The event to trigger the bookmarking on. Supported values include:
 
-                - `"response"` (the default): a bookmark is triggered when the assistant is done responding.
-                - `None`: no bookmark is triggered
+            - `"response"` (the default): a bookmark is triggered when the assistant is done responding.
+            - `None`: no bookmark is triggered
 
             When this method triggers a bookmark, it also updates the URL query string to reflect the bookmarked state.
 
@@ -1516,14 +1516,14 @@ async def set_chatlas_state(value: Jsonifiable) -> None:
         root_session = session.root_scope()
         root_session.bookmark.exclude.append(self.id + "_user_input")
 
-        if on is not None:
+        if bookmark_on is not None:
 
             # When ever the bookmark is requested, update the query string (indep of store type)
             @root_session.bookmark.on_bookmarked
             async def _(url: str):
                 await session.bookmark.update_query_string(url)
 
-        if on == "response":
+        if bookmark_on == "response":
 
             @reactive.effect
             @reactive.event(lambda: self.messages(format=MISSING), ignore_init=True)
@@ -1538,6 +1538,9 @@ async def _():
                 if last_message.get("role") == "assistant":
                     await session.bookmark()
 
+        ###############
+        # On Bookmark
+
         @root_session.bookmark.on_bookmark
         async def _on_bookmark_client(state: BookmarkState):
             if resolved_bookmark_id_str in state.values:
@@ -1670,8 +1673,8 @@ def enable_bookmarking(
         client: ClientWithState | chatlas.Chat[Any, Any],
         /,
         *,
-        store: Optional[BookmarkStore] = None,
-        on: Optional[Literal["response"]] = "response",
+        bookmark_store: Optional[BookmarkStore] = None,
+        bookmark_on: Optional[Literal["response"]] = "response",
     ) -> CancelCallback:
         """
         Enable bookmarking for the chat instance.
@@ -1687,15 +1690,15 @@ def enable_bookmarking(
             The chat client instance to use for bookmarking. This can be a Chat model
             provider from [chatlas](https://posit-dev.github.io/chatlas/), or more
             generally, an instance following the `ClientWithState` protocol.
-        store
+        bookmark_store
             A convenience parameter to set the `shiny.express.app_opts(bookmark_store=)`
             which is required for bookmarking (and `.enable_bookmarking()`). If `None`,
             no value will be set.
-        on
+        bookmark_on
             The event to trigger the bookmarking on. Supported values include:
 
-                - `"response"` (the default): a bookmark is triggered when the assistant is done responding.
-                - `None`: no bookmark is triggered
+            - `"response"` (the default): a bookmark is triggered when the assistant is done responding.
+            - `None`: no bookmark is triggered
 
             When this method triggers a bookmark, it also updates the URL query string to reflect the bookmarked state.
 
@@ -1705,12 +1708,12 @@ def enable_bookmarking(
             If the Shiny App does have bookmarking enabled.
         """
 
-        if store is not None:
+        if bookmark_store is not None:
             from ..express import app_opts
 
-            app_opts(bookmark_store=store)
+            app_opts(bookmark_store=bookmark_store)
 
-        return super().enable_bookmarking(client, on=on)
+        return super().enable_bookmarking(client, bookmark_on=bookmark_on)
 
 
 @add_example(ex_dir="../api-examples/Chat")
