Repository navigation
Commit 7d07f08
feat: add Button.setDownloadHandler to start a download on click (#10289)
## Summary
A `Button` can now start a file download when it is clicked. You give it
a `DownloadHandler`, and the server makes the file only when the browser
asks for it. You no longer need to wrap the button in an anchor or write
your own click-and-download code.
Closes #7203
## What changed
- Added `Button.setDownloadHandler(DownloadHandler)` and
`Button.getDownloadHandler()`.
- Inside, the button uses `Download.onClick(component, handler)`.
Setting a new handler removes the old one. Passing `null` turns the
download off.
- Click listeners still run as usual when a download handler is set.
- The file is served only while the button is attached, visible and
enabled. One exception: a button with disable-on-click disables itself
before the browser requests the file, so the file is also served while
the button is disabled by that click. Once the application sets the
enabled state explicitly (e.g. `setEnabled(false)`) or a parent is
disabled, the request is refused again. Use `handler.allowDisabled()` to
serve the file regardless of the enabled state.
- This change is backward-compatible: it only adds new methods.
## Use case
An admin view has an "Export" button that creates a CSV report when the
user clicks it. The report should only be built when the user actually
downloads it. The button should also stay disabled until the server
responds, so users cannot start many exports at once.
```java
Button export = new Button("Export CSV");
export.setDisableOnClick(DisableOnClickMode.UNTIL_RESPONSE);
export.setDownloadHandler(DownloadHandler.fromInputStream(event -> {
byte[] csv = reportService.createCsv();
return new DownloadResponse(new ByteArrayInputStream(csv),
"report.csv", "text/csv", csv.length);
}));
```
## API Changes
2 classes affected, 3 methods added
### com.vaadin.flow.component.button.Button
```java
// Added
public DownloadHandler getDownloadHandler() // null if clicking does not start a download
public void setDownloadHandler(DownloadHandler downloadHandler) // null turns the download off
```
### com.vaadin.flow.component.shared.internal.DisableOnClickController
(internal)
```java
// Added
public boolean isDisabledByClick() // true while disabled by the click, until the enabled state is set explicitly or restored
```
## Test summary
**Button download handler:**
- Old handler removed when a new one is set
- No handler registered after setting `null`
- Clicking downloads the handler's file in the browser (HTTP 200,
expected content)
- With disable on click, the file is served while the button is disabled
by the click
- When a click listener disables the button explicitly, or disables its
parent, the download is refused (HTTP 403)
- The controller reports disabled-by-click after a click, and clears it
when the enabled state is set explicitly or restored after the round
trip
---------
Co-authored-by: totally-not-ai[bot] <290682512+totally-not-ai[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Sascha Ißbrücker <sissbruecker@vaadin.com>1 parent e115118 commit 7d07f08
6 files changed
Lines changed: 461 additions & 0 deletions
File tree
- vaadin-button-flow-parent
- vaadin-button-flow-integration-tests/src
- main/java/com/vaadin/flow/component/button/tests
- test/java/com/vaadin/flow/component/button/tests
- vaadin-button-flow/src
- main/java/com/vaadin/flow/component/button
- test/java/com/vaadin/flow/component/button/tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
| 42 | + | |
41 | 43 | | |
42 | 44 | | |
43 | 45 | | |
| |||
49 | 51 | | |
50 | 52 | | |
51 | 53 | | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
52 | 59 | | |
53 | 60 | | |
54 | 61 | | |
| |||
72 | 79 | | |
73 | 80 | | |
74 | 81 | | |
| 82 | + | |
| 83 | + | |
75 | 84 | | |
76 | 85 | | |
77 | 86 | | |
| |||
370 | 379 | | |
371 | 380 | | |
372 | 381 | | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
| 479 | + | |
| 480 | + | |
| 481 | + | |
| 482 | + | |
| 483 | + | |
| 484 | + | |
| 485 | + | |
| 486 | + | |
| 487 | + | |
373 | 488 | | |
374 | 489 | | |
375 | 490 | | |
| |||
0 commit comments