-
Notifications
You must be signed in to change notification settings - Fork 210
feat: Add docs for DownloadHandler #4309
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
Conversation
AI Language ReviewThe provided files are new, so I am reviewing only the ".new" versions for clarity, accuracy, and completeness.
The documentation is generally comprehensive and well-structured. Just make sure to clarify the contexts and implications of technical configurations for users who might be new to servlet and Vaadin environments. |
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.
Pull Request Overview
This PR adds comprehensive documentation for the new DownloadHandler API in Vaadin 24.8, including multiple usage scenarios and API customization examples.
- Removed the legacy dynamic content documentation.
- Added detailed documentation for DownloadHandler covering classpath resource downloads, file system downloads, dynamic InputStream downloads, progress tracking, and custom download handlers.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
articles/flow/advanced/dynamic-content.adoc | Legacy documentation removed. |
articles/flow/advanced/downloads.adoc | New documentation added for the DownloadHandler API. |
Comments suppressed due to low confidence (1)
articles/flow/advanced/downloads.adoc:241
- [nitpick] The class name 'LinkWithM5Validation' is ambiguous; consider renaming it to something more descriptive, such as 'LinkWithChecksumValidation'.
private static class LinkWithM5Validation extends Anchor {
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…o download-handler
Converted to draft to not being merged before RC/GA |
Co-authored-by: caalador <mikael.grankvist@vaadin.com>
I've added the recently introduced |
Adds a documentation for new API for handling downloads in Vaadin 24.8.
Fixes #4303