Fix: Complete description for Upload documentation #4445
Conversation
|
|
|
|
| @@ -42,10 +43,12 @@ include::{root}/frontend/demo/component/upload/react/upload-basic.tsx[render,tag | |||
| endif::[] | |||
| -- | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Please restore these additional empty lines between sections. They help make the page structure more clear when editing the asciidoc.
fredpena
changed the title
…oad file size section
| @@ -22,7 +22,7 @@ The following built-in implementations of [classname]`UploadHandler` are availab | |||
|
|
|||
| - [classname]`InMemoryUploadHandler`, stores uploaded files in memory | |||
| - [classname]`FileUploadHandler`, stores uploaded files to the file system | |||
| - [classname]`TemporaryFileUploadHandler`, stores uploaded files to temporary filestly even when | |||
| - [classname]`TemporaryFileUploadHandler`, stores uploaded files to temporary files, typically using the system's temporary directory. This handler is useful when dealing with large files or when memory usage needs to be minimized. The temporary files are automatically deleted when the upload is complete or the component is detached. | |||
There was a problem hiding this comment.
The temporary files are automatically deleted when the upload is complete or the component is detached.
Does this reflect the current implementation? I can't find such deletion in the code.
There was a problem hiding this comment.
If it's true, there was confusion on my part. The files are not automatically deleted unless you unmount the component or manually.
Co-authored-by: Marco Collovati <[email protected]>
Remove 'The temporary files are automatically deleted when the upload is complete or the component is detached.'
|
@jouni do you have any further comments? I'd like to publish this update. |
|
No comments right now, merge if you want 👍 |
|
@fredpena thanks for contribution! 🏅 |
* docs: enhance description of TemporaryFileUploadHandler in file-handling.adoc * docs: Clarify Spring Boot multipart limits and stream handling in Upload file size section * Update articles/components/upload/index.adoc Co-authored-by: Marco Collovati <[email protected]> * Update file-handling.adoc Remove 'The temporary files are automatically deleted when the upload is complete or the component is detached.' --------- Co-authored-by: Marco Collovati <[email protected]> Co-authored-by: Mikhail Shabarov <[email protected]>
* docs: enhance description of TemporaryFileUploadHandler in file-handling.adoc * docs: Clarify Spring Boot multipart limits and stream handling in Upload file size section * Update articles/components/upload/index.adoc * Update file-handling.adoc Remove 'The temporary files are automatically deleted when the upload is complete or the component is detached.' --------- Co-authored-by: Fred Peña <[email protected]> Co-authored-by: Marco Collovati <[email protected]> Co-authored-by: Mikhail Shabarov <[email protected]>
docs: enhance description of TemporaryFileUploadHandler in file-handl…
Issues #4390, which reported that the description for
TemporaryFileUploadHandlerin theUploadcomponent documentation was incomplete and ended abruptly.The updated description now clearly explains:
This improvement helps developers better understand the available UploadHandler implementations and make more informed choices based on their application's needs.
docs: Clarify Spring Boot multipart limits and stream handling in Upl…
Improves the documentation for the Upload component's file size limitations in the "Upload Restrictions > File Size" section.
It addresses a common issue encountered when using Java Flow with Spring Boot, where file uploads fail due to Spring’s default multipart request limits (typically 1MB). The update adds guidance on how to:
This update is based on feedback from #4224 and provides more complete guidance for developers integrating Vaadin Upload with Spring Boot.