Repository navigation
docs(chat): describe auto-scroll and scroll to latest - #318
danielleroux wants to merge 2 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| - **Responsiveness:** Chats will resize to a max-width of `45rem`. | ||
| - **Auto-scroll:** By default, the chat keeps the latest content in view while new messages are added or a response streams. Auto-scroll stops as soon as users scroll away from the bottom and resumes when they return to the bottom, select "Scroll to latest" or send a new prompt. | ||
| - **Scroll to latest:** While users are away from the bottom, a "Scroll to latest" button is shown above the chat input. It never covers the chat input and scrolls without animation when users prefer reduced motion. | ||
| - **Custom scroll behavior:** Turn off auto-scroll and the "Scroll to latest" button with `suppressAutoScroll` if the application controls scrolling itself, e.g. to scroll to the start of a new answer. Use `scrollToBottom()` and `scrollToTop()` to scroll programmatically, e.g. after loading a conversation. |
There was a problem hiding this comment.
- this last bullet point is not behavior in context - move it to the (new) options section
- avoid technical jargon e.g.
supressAutoScroll
| - [Panes](../panes): Use when the chat is a secondary feature, e.g. for contextual help | ||
| - **Responsiveness:** Chats will resize to a max-width of `45rem`. | ||
| - **Auto-scroll:** By default, the chat keeps the latest content in view while new messages are added or a response streams. Auto-scroll stops as soon as users scroll away from the bottom and resumes when they return to the bottom, select "Scroll to latest" or send a new prompt. | ||
| - **Scroll to latest:** While users are away from the bottom, a "Scroll to latest" button is shown above the chat input. It never covers the chat input and scrolls without animation when users prefer reduced motion. |
There was a problem hiding this comment.
as there is currently no code example visualizing this, should we add an illustration?
Summary
Documents Auto-scroll for
ix-chat: default behaviour, the scroll-to-latest button,suppressAutoScrolland thescrollToBottom()/scrollToTop()methods.Code: siemens/ix#2917 (the docs preview builds against it via
.env.pullrequest).Refs IX-14. Stacked on the chat input Interrupt docs PR.