-
Notifications
You must be signed in to change notification settings - Fork 261
feat: add scrollable code blocks and tables with auto-scroll during streaming #444
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sleitor
wants to merge
1
commit into
vercel:main
Choose a base branch
from
sleitor:feature/scrollable-code-blocks-tables
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "streamdown": minor | ||
| --- | ||
|
|
||
| Add codeBlockMaxHeight and tableMaxHeight props with streaming auto-scroll |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| import { render } from "@testing-library/react"; | ||
| import type { ReactNode } from "react"; | ||
| import { describe, expect, it, vi } from "vitest"; | ||
| import { StreamdownContext, type StreamdownContextType } from "../index"; | ||
| import { Table } from "../lib/table"; | ||
|
|
||
| const defaultContext: StreamdownContextType = { | ||
| codeBlockMaxHeight: 400, | ||
| controls: false, | ||
| isAnimating: false, | ||
| linkSafety: { enabled: true }, | ||
| mermaid: undefined, | ||
| mode: "streaming", | ||
| shikiTheme: ["github-light", "github-dark"], | ||
| tableMaxHeight: 300, | ||
| }; | ||
|
|
||
| function renderWithContext( | ||
| ui: ReactNode, | ||
| ctx: Partial<StreamdownContextType> = {} | ||
| ) { | ||
| return render( | ||
| <StreamdownContext.Provider value={{ ...defaultContext, ...ctx }}> | ||
| {ui} | ||
| </StreamdownContext.Provider> | ||
| ); | ||
| } | ||
|
|
||
| describe("Table scroll", () => { | ||
| it("renders inner scroll div with maxHeight style when maxHeight provided", () => { | ||
| const { container } = renderWithContext( | ||
| <Table maxHeight={300}> | ||
| <tbody> | ||
| <tr> | ||
| <td>cell</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table> | ||
| ); | ||
|
|
||
| const scrollDiv = container.querySelector( | ||
| '[data-streamdown="table-wrapper"] > div:last-child' | ||
| ); | ||
| expect(scrollDiv).toBeTruthy(); | ||
| expect(scrollDiv?.getAttribute("style")).toContain("max-height"); | ||
| }); | ||
|
|
||
| it("accepts string maxHeight value", () => { | ||
| const { container } = renderWithContext( | ||
| <Table maxHeight="50vh"> | ||
| <tbody> | ||
| <tr> | ||
| <td>cell</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table> | ||
| ); | ||
|
|
||
| const scrollDiv = container.querySelector( | ||
| '[data-streamdown="table-wrapper"] > div:last-child' | ||
| ); | ||
| expect(scrollDiv?.getAttribute("style")).toContain("50vh"); | ||
| }); | ||
|
|
||
| it("does not set maxHeight style when maxHeight is undefined", () => { | ||
| const { container } = renderWithContext( | ||
| <Table> | ||
| <tbody> | ||
| <tr> | ||
| <td>cell</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table> | ||
| ); | ||
|
|
||
| const scrollDiv = container.querySelector( | ||
| '[data-streamdown="table-wrapper"] > div:last-child' | ||
| ); | ||
| expect(scrollDiv?.getAttribute("style") ?? "").not.toContain("max-height"); | ||
| }); | ||
|
|
||
| it("calls scrollTo on children update when isAnimating and pinned", () => { | ||
| const scrollToSpy = vi.fn(); | ||
|
|
||
| const { container, rerender } = renderWithContext( | ||
| <Table maxHeight={300}> | ||
| <tbody> | ||
| <tr> | ||
| <td>row1</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table>, | ||
| { isAnimating: true } | ||
| ); | ||
|
|
||
| const scrollDiv = container.querySelector( | ||
| '[data-streamdown="table-wrapper"] > div:last-child' | ||
| ) as HTMLElement; | ||
|
|
||
| Object.defineProperty(scrollDiv, "scrollHeight", { | ||
| value: 1000, | ||
| configurable: true, | ||
| }); | ||
| Object.defineProperty(scrollDiv, "clientHeight", { | ||
| value: 300, | ||
| configurable: true, | ||
| }); | ||
| Object.defineProperty(scrollDiv, "scrollTop", { | ||
| value: 700, | ||
| configurable: true, | ||
| writable: true, | ||
| }); | ||
| scrollDiv.scrollTo = scrollToSpy; | ||
|
|
||
| rerender( | ||
| <StreamdownContext.Provider | ||
| value={{ ...defaultContext, isAnimating: true }} | ||
| > | ||
| <Table maxHeight={300}> | ||
| <tbody> | ||
| <tr> | ||
| <td>row1</td> | ||
| </tr> | ||
| <tr> | ||
| <td>row2</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table> | ||
| </StreamdownContext.Provider> | ||
| ); | ||
|
|
||
| expect(scrollToSpy).toHaveBeenCalledWith({ | ||
| top: expect.any(Number), | ||
| behavior: "instant", | ||
| }); | ||
| }); | ||
|
|
||
| it("does not call scrollTo when isAnimating is false", () => { | ||
| const scrollToSpy = vi.fn(); | ||
|
|
||
| const { container, rerender } = renderWithContext( | ||
| <Table maxHeight={300}> | ||
| <tbody> | ||
| <tr> | ||
| <td>row1</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table>, | ||
| { isAnimating: false } | ||
| ); | ||
|
|
||
| const scrollDiv = container.querySelector( | ||
| '[data-streamdown="table-wrapper"] > div:last-child' | ||
| ) as HTMLElement; | ||
|
|
||
| Object.defineProperty(scrollDiv, "scrollHeight", { | ||
| value: 1000, | ||
| configurable: true, | ||
| }); | ||
| scrollDiv.scrollTo = scrollToSpy; | ||
|
|
||
| rerender( | ||
| <StreamdownContext.Provider | ||
| value={{ ...defaultContext, isAnimating: false }} | ||
| > | ||
| <Table maxHeight={300}> | ||
| <tbody> | ||
| <tr> | ||
| <td>row1</td> | ||
| </tr> | ||
| <tr> | ||
| <td>row2</td> | ||
| </tr> | ||
| </tbody> | ||
| </Table> | ||
| </StreamdownContext.Provider> | ||
| ); | ||
|
|
||
| expect(scrollToSpy).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auto-scroll useEffect in CodeBlockBody and Table components has incomplete dependency arrays, causing scroll-to-bottom to only fire once during streaming instead of on each content update.