Remove ability to control server-side (in the future, we may want this, but if we do in fact support it, we should have some sort of visual cue that their is overflow -- i.e., a scroll button)

Author: cpsievert

js/chat/_utils.ts

@@ -1,15 +1,10 @@
 export function createElement(
   tag_name: string,
-  attrs: { [key: string]: string | boolean | null }
+  attrs: { [key: string]: string | null }
 ): HTMLElement {
   const el = document.createElement(tag_name);
   for (const [key, value] of Object.entries(attrs)) {
-    if (value === null) continue;
-    if (typeof value === "boolean") {
-      if (value) el.setAttribute(key, "");
-      continue;
-    }
-    el.setAttribute(key, value);
+    if (value !== null) el.setAttribute(key, value);
   }
   return el;
 }

js/chat/chat.ts

@@ -14,9 +14,8 @@ type ContentType = "markdown" | "html" | "text";
 type Message = {
   content: string;
   role: "user" | "assistant";
-  content_type: ContentType;
   chunk_type: "message_start" | "message_end" | null;
-  request_scroll: boolean;
+  content_type: ContentType;
 };
 type ShinyChatMessage = {
   id: string;
@@ -52,8 +51,6 @@ class LightElement extends LitElement {
 class ChatMessage extends LightElement {
   @property() content = "...";
   @property() content_type: ContentType = "markdown";
-  // Boolean to determine whether to scroll to the bottom after updating content
-  @property({ type: Boolean }) request_scroll = false;
 
   render(): ReturnType<LitElement["render"]> {
     let content;
@@ -80,14 +77,7 @@ class ChatMessage extends LightElement {
   updated(changedProperties: Map<string, unknown>): void {
     if (changedProperties.has("content")) {
       this.#highlightAndCodeCopy();
-
-      if (this.request_scroll) {
-        const event = new CustomEvent("shiny-chat-request-scroll", {
-          bubbles: true,
-          composed: true,
-        });
-        this.dispatchEvent(event);
-      }
+      this.#requestScroll();
     }
   }
 
@@ -117,6 +107,15 @@ class ChatMessage extends LightElement {
       });
     });
   }
+
+  #requestScroll(): void {
+    this.dispatchEvent(
+      new CustomEvent("shiny-chat-request-scroll", {
+        bubbles: true,
+        composed: true,
+      })
+    );
+  }
 }
 
 class ChatUserMessage extends LightElement {

shiny/ui/_chat.py

@@ -187,7 +187,7 @@ def __init__(
 
             # Initialize the chat with the provided messages
             for msg in messages:
-                _utils.run_coro_sync(self.append_message(msg, scroll=False))
+                _utils.run_coro_sync(self.append_message(msg))
 
             # When user input is submitted, transform, and store it in the chat state
             # (and make sure this runs before other effects since when the user
@@ -399,7 +399,7 @@ def messages(
 
         return tuple(res)
 
-    async def append_message(self, message: Any, scroll: bool = True) -> None:
+    async def append_message(self, message: Any) -> None:
         """
         Append a message to the chat.
 
@@ -409,23 +409,16 @@ async def append_message(self, message: Any, scroll: bool = True) -> None:
             The message to append. A variety of message formats are supported including
             a string, a dictionary with `content` and `role` keys, or a relevant chat
             completion object from platforms like OpenAI, Anthropic, Ollama, and others.
-        scroll
-            Whether to scroll to the bottom of the chat after appending the message.
 
         Note
         ----
         Use `.append_message_stream()` instead of this method when `stream=True` (or
         similar) is specified in model's completion method.
         """
-        await self._append_message(message, scroll=scroll)
+        await self._append_message(message)
 
     async def _append_message(
-        self,
-        message: Any,
-        *,
-        chunk: ChunkOption = False,
-        stream_id: str | None = None,
-        scroll: bool = True,
+        self, message: Any, *, chunk: ChunkOption = False, stream_id: str | None = None
     ) -> None:
         # If currently we're in a stream, handle other messages (outside the stream) later
         if not self._can_append_message(stream_id):
@@ -455,11 +448,9 @@ async def _append_message(
         if msg is None:
             return
         msg = self._store_message(msg, chunk=chunk)
-        await self._send_append_message(msg, chunk=chunk, scroll=scroll)
+        await self._send_append_message(msg, chunk=chunk)
 
-    async def append_message_stream(
-        self, message: Iterable[Any] | AsyncIterable[Any], scroll: bool = True
-    ):
+    async def append_message_stream(self, message: Iterable[Any] | AsyncIterable[Any]):
         """
         Append a message as a stream of message chunks.
 
@@ -470,8 +461,6 @@ async def append_message_stream(
             message chunk formats are supported, including a string, a dictionary with
             `content` and `role` keys, or a relevant chat completion object from
             platforms like OpenAI, Anthropic, Ollama, and others.
-        scroll
-            Whether to scroll to the bottom of the chat while appending the message stream.
 
         Note
         ----
@@ -484,7 +473,7 @@ async def append_message_stream(
         # Run the stream in the background to get non-blocking behavior
         @reactive.extended_task
         async def _stream_task():
-            await self._append_message_stream(message, scroll=scroll)
+            await self._append_message_stream(message)
 
         _stream_task()
 
@@ -504,17 +493,17 @@ async def _handle_error():
         ctx.on_invalidate(_handle_error.destroy)
         self._effects.append(_handle_error)
 
-    async def _append_message_stream(self, message: AsyncIterable[Any], scroll: bool):
+    async def _append_message_stream(self, message: AsyncIterable[Any]):
         id = _utils.private_random_id()
 
         empty = ChatMessage(content="", role="assistant")
-        await self._append_message(empty, chunk="start", stream_id=id, scroll=scroll)
+        await self._append_message(empty, chunk="start", stream_id=id)
 
         try:
             async for msg in message:
-                await self._append_message(msg, chunk=True, stream_id=id, scroll=scroll)
+                await self._append_message(msg, chunk=True, stream_id=id)
         finally:
-            await self._append_message(empty, chunk="end", stream_id=id, scroll=scroll)
+            await self._append_message(empty, chunk="end", stream_id=id)
             await self._flush_pending_messages()
 
     async def _flush_pending_messages(self):
@@ -536,7 +525,6 @@ async def _send_append_message(
         self,
         message: StoredMessage,
         chunk: ChunkOption = False,
-        scroll: bool = True,
     ):
         if message["role"] == "system":
             # System messages are not displayed in the UI
@@ -561,7 +549,6 @@ async def _send_append_message(
             role=message["role"],
             content_type=content_type,
             chunk_type=chunk_type,
-            request_scroll=scroll,
         )
 
         # print(msg)

shiny/ui/_chat_types.py

@@ -31,4 +31,3 @@ class StoredMessage(TransformedMessage):
 class ClientMessage(ChatMessage):
     content_type: Literal["markdown", "html"]
     chunk_type: Literal["message_start", "message_end"] | None
-    request_scroll: bool