Skip to content

Commit 818e853

Browse files
authored
fix: don't raise item-click when focusable header is clicked after item keys are changed. (#2327)
* fix: prevent un-expected click to happen. * chore: run formatter * fix: remove setting of activeItem * fix: use eventContext to handle itemClickEvent fired when clicked on focuable header. * chore: don't use import.* for reducing cherry-pick conflict. * chore: fix formatting
1 parent 9562536 commit 818e853

3 files changed

Lines changed: 85 additions & 8 deletions

File tree

‎vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/main/java/com/vaadin/flow/component/grid/it/ItemClickListenerPage.java‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,23 @@
1515
*/
1616
package com.vaadin.flow.component.grid.it;
1717

18+
import com.vaadin.flow.component.button.Button;
1819
import com.vaadin.flow.component.checkbox.Checkbox;
1920
import com.vaadin.flow.component.grid.Grid;
2021
import com.vaadin.flow.component.html.Div;
2122
import com.vaadin.flow.component.html.Span;
23+
import com.vaadin.flow.component.textfield.TextField;
24+
import com.vaadin.flow.data.provider.ListDataProvider;
2225
import com.vaadin.flow.data.renderer.ComponentRenderer;
2326
import com.vaadin.flow.function.SerializableFunction;
2427
import com.vaadin.flow.router.Route;
28+
import org.apache.commons.lang3.StringUtils;
29+
30+
import java.util.Arrays;
2531

2632
@Route("vaadin-grid/item-click-listener")
2733
public class ItemClickListenerPage extends Div {
34+
static final String GRID_FILTER_FOCUSABLE_HEADER = "grid-filter-focusable-header";
2835

2936
public ItemClickListenerPage() {
3037
Div clickMsg = new Div();
@@ -62,6 +69,8 @@ public ItemClickListenerPage() {
6269
grid.setDetailsVisible("bar", true);
6370

6471
add(grid, clickMsg, dblClickMsg, columnClickMsg, columnDblClickMsg);
72+
73+
createGridWithChangingKeysOfItemsAndFocusableHeader();
6574
}
6675

6776
private static Span getDetailsComponent(String s) {
@@ -70,4 +79,39 @@ private static Span getDetailsComponent(String s) {
7079
return result;
7180
}
7281

82+
private void createGridWithChangingKeysOfItemsAndFocusableHeader() {
83+
Span message = new Span();
84+
message.setId("item-click-event-log");
85+
86+
ListDataProvider<String> dataProvider = new ListDataProvider<>(
87+
Arrays.asList("a", "b", "c"));
88+
Grid<String> grid = new Grid<>();
89+
grid.setItems(dataProvider);
90+
grid.addColumn(x -> x).setHeader("Header");
91+
grid.addItemClickListener(ev -> message.setText("ItemClicked"));
92+
grid.setId(GRID_FILTER_FOCUSABLE_HEADER);
93+
94+
Button filterButton = new Button("Filter");
95+
filterButton.setId("filterButton");
96+
Button clearFilterButton = new Button("Clear filter");
97+
clearFilterButton.setId("clearFilterButton");
98+
99+
filterButton.addClickListener(event -> filterGrid(dataProvider, "b"));
100+
clearFilterButton
101+
.addClickListener(event -> filterGrid(dataProvider, null));
102+
103+
TextField focusableHeader = new TextField();
104+
focusableHeader.setId("focusableHeader");
105+
grid.prependHeaderRow().getCells().get(0).setComponent(focusableHeader);
106+
add(grid, filterButton, clearFilterButton, message);
107+
}
108+
109+
private void filterGrid(ListDataProvider<String> dataProvider,
110+
String filterValue) {
111+
dataProvider.clearFilters();
112+
if (filterValue != null) {
113+
dataProvider.addFilter(
114+
item -> StringUtils.containsIgnoreCase(item, filterValue));
115+
}
116+
}
73117
}

‎vaadin-grid-flow-parent/vaadin-grid-flow-integration-tests/src/test/java/com/vaadin/flow/component/grid/it/ItemClickListenerIT.java‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.vaadin.flow.component.grid.it;
1717

18+
import com.vaadin.flow.component.button.testbench.ButtonElement;
1819
import com.vaadin.tests.AbstractComponentIT;
1920
import org.hamcrest.CoreMatchers;
2021
import org.hamcrest.Matchers;
@@ -29,6 +30,8 @@
2930
import com.vaadin.testbench.TestBenchElement;
3031
import org.openqa.selenium.WebElement;
3132

33+
import static com.vaadin.flow.component.grid.it.ItemClickListenerPage.GRID_FILTER_FOCUSABLE_HEADER;
34+
3235
@TestPath("vaadin-grid/item-click-listener")
3336
public class ItemClickListenerIT extends AbstractComponentIT {
3437

@@ -119,6 +122,37 @@ public void doubleClickDetailsCell_noItemClickEventFired() {
119122
Assert.assertEquals("", getClickMessage());
120123
}
121124

125+
// Regression test for this issue:
126+
// https://github.com/vaadin/flow-components/issues/2247
127+
@Test
128+
public void gridItemKeysChanged_whenFocusableHeaderElementClicked_shouldNotRaiseItemClickEvent() {
129+
open();
130+
131+
// wait for grid to be loaded
132+
waitUntil(driver -> $(GridElement.class)
133+
.id(GRID_FILTER_FOCUSABLE_HEADER).getRowCount() > 0);
134+
135+
GridElement gridElement = $(GridElement.class)
136+
.id(GRID_FILTER_FOCUSABLE_HEADER);
137+
138+
// Select an item with specific key
139+
gridElement.select(0);
140+
141+
// Trigger key change on grid items by filtering
142+
ButtonElement filterButton = $(ButtonElement.class).id("filterButton");
143+
ButtonElement clearFilterButton = $(ButtonElement.class)
144+
.id("clearFilterButton");
145+
filterButton.click();
146+
clearFilterButton.click();
147+
148+
WebElement focusableHeader = gridElement
149+
.findElement(By.id("focusableHeader"));
150+
focusableHeader.click();
151+
152+
TestBenchElement span = $("span").id("item-click-event-log");
153+
Assert.assertEquals("", span.getText());
154+
}
155+
122156
private String getColumnDoubleClickMessage() {
123157
return findElement(By.id("columnDblClickMsg")).getText();
124158
}

‎vaadin-grid-flow-parent/vaadin-grid-flow/src/main/resources/META-INF/resources/frontend/gridConnector.js‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { Debouncer } from '@polymer/polymer/lib/utils/debounce.js';
22
import { timeOut, animationFrame } from '@polymer/polymer/lib/utils/async.js';
33
import { Grid } from '@vaadin/grid/src/vaadin-grid.js';
44
import { ItemCache } from '@vaadin/grid/src/vaadin-grid-data-provider-mixin.js';
5+
import { isFocusable } from '@vaadin/grid/src/vaadin-grid-active-item-mixin.js';
56

67
(function () {
78
const tryCatchWrapper = function (callback) {
@@ -171,7 +172,6 @@ import { ItemCache } from '@vaadin/grid/src/vaadin-grid-data-provider-mixin.js';
171172
const isSelectedItemDifferentOrNull = !grid.activeItem || !item || item.key != grid.activeItem.key;
172173
if (!userOriginated && selectionMode === 'SINGLE' && isSelectedItemDifferentOrNull) {
173174
grid.activeItem = item;
174-
grid.$connector.activeItem = item;
175175
}
176176
});
177177
});
@@ -966,10 +966,6 @@ import { ItemCache } from '@vaadin/grid/src/vaadin-grid-data-provider-mixin.js';
966966
};
967967
});
968968

969-
grid.addEventListener('cell-activate', tryCatchWrapper(e => {
970-
grid.$connector.activeItem = e.detail.model.item;
971-
setTimeout(() => grid.$connector.activeItem = undefined);
972-
}));
973969
grid.addEventListener('click', tryCatchWrapper(e => _fireClickEvent(e, 'item-click')));
974970
grid.addEventListener('dblclick', tryCatchWrapper(e => _fireClickEvent(e, 'item-double-click')));
975971

@@ -1020,9 +1016,12 @@ import { ItemCache } from '@vaadin/grid/src/vaadin-grid-data-provider-mixin.js';
10201016
}));
10211017

10221018
function _fireClickEvent(event, eventName) {
1023-
if (grid.$connector.activeItem) {
1024-
event.itemKey = grid.$connector.activeItem.key;
1025-
const eventContext = grid.getEventContext(event);
1019+
const target = event.target;
1020+
const eventContext = grid.getEventContext(event);
1021+
const section = eventContext.section;
1022+
1023+
if (eventContext.item && !isFocusable(target) && section !== 'details') {
1024+
event.itemKey = eventContext.item.key;
10261025
// if you have a details-renderer, getEventContext().column is undefined
10271026
if (eventContext.column) {
10281027
event.internalColumnId = eventContext.column._flowId;

0 commit comments

Comments
 (0)