Skip to content

Commit 54e98a1

Browse files
authored
fix: prevent toggling overlay opened state when filtering (#3886)
* fix: prevent toggling overlay opened state when filtering * extract _refreshData method * improve test setup * move tests to lazy-loading test suite * remove unused import
1 parent 2deba69 commit 54e98a1

2 files changed

Lines changed: 66 additions & 12 deletions

File tree

‎packages/combo-box/src/vaadin-combo-box-data-provider-mixin.js‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,6 @@ export const ComboBoxDataProviderMixin = (superClass) =>
7474
];
7575
}
7676

77-
/** @private */
78-
_dataProviderClearFilter(dataProvider, opened, value) {
79-
// Can't depend on filter in this observer as we don't want
80-
// to clear the filter whenever it's set
81-
if (dataProvider && !this.loading && this.filter && !(opened && this.autoOpenDisabled && value === this.filter)) {
82-
this.size = undefined;
83-
this._pendingRequests = {};
84-
this.filter = '';
85-
this.clearCache();
86-
}
87-
}
88-
8977
/** @protected */
9078
ready() {
9179
super.ready();
@@ -118,8 +106,32 @@ export const ComboBoxDataProviderMixin = (superClass) =>
118106
return;
119107
}
120108

109+
this._refreshData();
110+
}
111+
112+
/** @private */
113+
_dataProviderClearFilter(dataProvider, opened, value) {
114+
// Can't depend on filter in this observer as we don't want
115+
// to clear the filter whenever it's set
116+
if (dataProvider && !this.loading && this.filter && !(opened && this.autoOpenDisabled && value === this.filter)) {
117+
this._refreshData(true);
118+
}
119+
}
120+
121+
/** @private */
122+
_refreshData(clearFilter) {
123+
// Immediately mark as loading if this refresh leads to re-fetching pages
124+
// This prevents some issues with the properties below triggering
125+
// observers that also rely on the loading state
126+
this.loading = this._shouldFetchData();
127+
// Reset size and internal loading state
121128
this.size = undefined;
122129
this._pendingRequests = {};
130+
// Clear filter if requested
131+
if (clearFilter) {
132+
this.filter = '';
133+
}
134+
// Clear cached pages, and reload current page if we need the data
123135
this.clearCache();
124136
}
125137

‎packages/combo-box/test/lazy-loading.test.js‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,6 +1135,48 @@ describe('lazy loading', () => {
11351135
expect(comboBox.filteredItems).to.contain('item 293');
11361136
});
11371137
});
1138+
1139+
describe('dropdown behaviour', () => {
1140+
let dropdown;
1141+
let openedSpy;
1142+
1143+
beforeEach(() => {
1144+
dropdown = comboBox.$.dropdown;
1145+
comboBox.dataProvider = spyDataProvider;
1146+
comboBox.opened = true;
1147+
spyDataProvider.resetHistory();
1148+
1149+
openedSpy = sinon.spy();
1150+
dropdown.addEventListener('vaadin-combo-box-dropdown-opened', openedSpy);
1151+
});
1152+
1153+
it('should not toggle between opened and closed when filtering', () => {
1154+
// Filter for something that should return results
1155+
comboBox.filter = 'item';
1156+
// Verify data provider has been called
1157+
expect(spyDataProvider.calledOnce).to.be.true;
1158+
// Dropdown should not have been closed and re-opened
1159+
expect(openedSpy.called).to.be.false;
1160+
});
1161+
1162+
it('should not toggle between opened and closed when setting a value', () => {
1163+
// Filter for something that should return results
1164+
comboBox.filter = 'item';
1165+
// Set a value
1166+
comboBox.value = 'item 1';
1167+
// Dropdown should not have been closed and re-opened
1168+
expect(openedSpy.called).to.be.false;
1169+
});
1170+
1171+
it('should close when there are no items', () => {
1172+
// Filter for something that doesn't exist
1173+
comboBox.filter = 'doesnotexist';
1174+
// Verify data provider has been called
1175+
expect(spyDataProvider.calledOnce).to.be.true;
1176+
// Dropdown should close
1177+
expect(dropdown._overlayOpened).to.be.false;
1178+
});
1179+
});
11381180
};
11391181

11401182
describe('combo-box', () => {

0 commit comments

Comments
 (0)