-
Notifications
You must be signed in to change notification settings - Fork 0
MarkdownViewer article and demos #696
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
base: main
Are you sure you want to change the base?
Conversation
hyyan
left a comment
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.
@laurenic0l This article has a few issues. The flow is not completely smooth, and it makes some incorrect assumptions.
-
Conflates "streaming" with "progressive rendering"
append()works independently - content appears immediately if progressiveRender is off- "Streaming methods" section title is misleading
- Streaming is about receiving data from server
- Progressive rendering is about displaying it character-by-character
-
Missing dependency clarity
isRendering()only meaningful when progressiveRender is enabledstop(),flush(),whenRenderComplete()only work with progressiveRender on- These dependencies aren't explained
-
Auto-scroll placement
- Presented as if related to streaming, but it's completely independent
- Can be used with or without streaming/progressive rendering
-
Organization implies wrong flow
- Suggests you need "streaming methods" for progressive rendering
- Reality: you can append() without progressiveRender
I suggest this structure, please verify:
- Setting content
- Appending content (for any incremental updates)
- Auto-scroll (independent feature)
- Progressive rendering (visual typewriter effect)
- Enable it
- Render speed
- Render state (isRendering)
- Controlling rendering (stop/flush)
- Waiting for completion (whenRenderComplete)
- Clearing content
- Syntax highlighting
src/main/java/com/webforj/samples/views/markdownviewer/MarkdownViewerView.java
Outdated
Show resolved
Hide resolved
src/main/java/com/webforj/samples/views/markdownviewer/MarkdownViewerView.java
Show resolved
Hide resolved
src/main/java/com/webforj/samples/views/markdownviewer/MarkdownViewerStreamingView.java
Outdated
Show resolved
Hide resolved
src/main/java/com/webforj/samples/views/markdownviewer/MarkdownViewerStreamingView.java
Show resolved
Hide resolved
62c2859 to
fde2508
Compare
Here's the first draft of the MarkdownViewer documentation. POM file should be updated with 25.11
closes #659