Skip to content

Commit bac984d

Browse files
authored
fix: clear possible bad input when setting an empty value (#4413)
1 parent b09f651 commit bac984d

8 files changed

Lines changed: 113 additions & 9 deletions

File tree

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package com.vaadin.flow.component.datepicker;
2+
3+
import com.vaadin.flow.component.html.Div;
4+
import com.vaadin.flow.component.html.NativeButton;
5+
import com.vaadin.flow.router.Route;
6+
7+
@Route("vaadin-date-picker/clear-value")
8+
public class ClearValuePage extends Div {
9+
public static final String CLEAR_BUTTON = "clear-button";
10+
11+
public ClearValuePage() {
12+
DatePicker datePicker = new DatePicker();
13+
14+
NativeButton clearButton = new NativeButton("Clear value");
15+
clearButton.setId(CLEAR_BUTTON);
16+
clearButton.addClickListener(event -> datePicker.clear());
17+
18+
add(datePicker, clearButton);
19+
}
20+
}

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow-integration-tests/src/main/java/com/vaadin/flow/component/datepicker/validation/BasicValidationPage.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ public class BasicValidationPage extends AbstractValidationPage<DatePicker> {
1111
public static final String REQUIRED_BUTTON = "required-button";
1212
public static final String MIN_INPUT = "min-input";
1313
public static final String MAX_INPUT = "max-input";
14+
public static final String CLEAR_VALUE_BUTTON = "clear-value-button";
1415

1516
public BasicValidationPage() {
1617
super();
@@ -28,6 +29,10 @@ public BasicValidationPage() {
2829
LocalDate value = LocalDate.parse(event.getValue());
2930
testField.setMax(value);
3031
}));
32+
33+
add(createButton(CLEAR_VALUE_BUTTON, "Clear value", event -> {
34+
testField.clear();
35+
}));
3136
}
3237

3338
protected DatePicker createTestField() {

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow-integration-tests/src/main/java/com/vaadin/flow/component/datepicker/validation/BinderValidationPage.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
public class BinderValidationPage extends AbstractValidationPage<DatePicker> {
1212
public static final String MIN_INPUT = "min-input";
1313
public static final String MAX_INPUT = "max-input";
14+
public static final String CLEAR_VALUE_BUTTON = "clear-value-button";
1415
public static final String EXPECTED_VALUE_INPUT = "expected-value-input";
1516

1617
public static final String REQUIRED_ERROR_MESSAGE = "The field is required";
@@ -55,6 +56,10 @@ public BinderValidationPage() {
5556
LocalDate value = LocalDate.parse(event.getValue());
5657
testField.setMax(value);
5758
}));
59+
60+
add(createButton(CLEAR_VALUE_BUTTON, "Clear value", event -> {
61+
testField.clear();
62+
}));
5863
}
5964

6065
protected DatePicker createTestField() {
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
package com.vaadin.flow.component.datepicker;
2+
3+
import org.junit.Assert;
4+
import org.junit.Before;
5+
import org.junit.Test;
6+
import org.openqa.selenium.Keys;
7+
8+
import com.vaadin.flow.component.datepicker.testbench.DatePickerElement;
9+
import com.vaadin.flow.testutil.TestPath;
10+
import com.vaadin.tests.AbstractComponentIT;
11+
12+
import static com.vaadin.flow.component.datepicker.ClearValuePage.CLEAR_BUTTON;
13+
14+
@TestPath("vaadin-date-picker/clear-value")
15+
public class ClearValueIT extends AbstractComponentIT {
16+
private DatePickerElement datePicker;
17+
18+
@Before
19+
public void init() {
20+
open();
21+
datePicker = $(DatePickerElement.class).first();
22+
}
23+
24+
@Test
25+
public void setInputValue_clearValue_inputValueIsEmpty() {
26+
datePicker.sendKeys("1/1/2022", Keys.ENTER);
27+
Assert.assertEquals("1/1/2022", datePicker.getInputValue());
28+
29+
$("button").id(CLEAR_BUTTON).click();
30+
Assert.assertEquals("", datePicker.getInputValue());
31+
}
32+
33+
@Test
34+
public void setBadInputValue_clearValue_inputValueIsEmpty() {
35+
datePicker.sendKeys("INVALID", Keys.ENTER);
36+
Assert.assertEquals("INVALID", datePicker.getInputValue());
37+
38+
$("button").id(CLEAR_BUTTON).click();
39+
Assert.assertEquals("", datePicker.getInputValue());
40+
}
41+
}

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow-integration-tests/src/test/java/com/vaadin/flow/component/datepicker/validation/BasicValidationIT.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import static com.vaadin.flow.component.datepicker.validation.BasicValidationPage.MIN_INPUT;
1111
import static com.vaadin.flow.component.datepicker.validation.BasicValidationPage.MAX_INPUT;
1212
import static com.vaadin.flow.component.datepicker.validation.BasicValidationPage.REQUIRED_BUTTON;
13+
import static com.vaadin.flow.component.datepicker.validation.BasicValidationPage.CLEAR_VALUE_BUTTON;
1314

1415
@TestPath("vaadin-date-picker/validation/basic")
1516
public class BasicValidationIT extends AbstractValidationIT<DatePickerElement> {
@@ -97,6 +98,17 @@ public void badInput_changeValue_assertValidity() {
9798
assertClientInvalid();
9899
}
99100

101+
@Test
102+
public void badInput_setValue_clearValue_assertValidity() {
103+
testField.setInputValue("INVALID");
104+
assertServerInvalid();
105+
assertClientInvalid();
106+
107+
$("button").id(CLEAR_VALUE_BUTTON).click();
108+
assertServerValid();
109+
assertClientValid();
110+
}
111+
100112
@Test
101113
public void detach_attach_preservesInvalidState() {
102114
// Make field invalid

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow-integration-tests/src/test/java/com/vaadin/flow/component/datepicker/validation/BinderValidationIT.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import static com.vaadin.flow.component.datepicker.validation.BinderValidationPage.EXPECTED_VALUE_INPUT;
1313
import static com.vaadin.flow.component.datepicker.validation.BinderValidationPage.REQUIRED_ERROR_MESSAGE;
1414
import static com.vaadin.flow.component.datepicker.validation.BinderValidationPage.UNEXPECTED_VALUE_ERROR_MESSAGE;
15+
import static com.vaadin.flow.component.datepicker.validation.BinderValidationPage.CLEAR_VALUE_BUTTON;
1516

1617
@TestPath("vaadin-date-picker/validation/binder")
1718
public class BinderValidationIT
@@ -110,6 +111,19 @@ public void badInput_changeValue_assertValidity() {
110111
assertErrorMessage("");
111112
}
112113

114+
@Test
115+
public void badInput_setValue_clearValue_assertValidity() {
116+
testField.setInputValue("INVALID");
117+
assertServerInvalid();
118+
assertClientInvalid();
119+
assertErrorMessage("");
120+
121+
$("button").id(CLEAR_VALUE_BUTTON).click();
122+
assertServerInvalid();
123+
assertClientInvalid();
124+
assertErrorMessage(REQUIRED_ERROR_MESSAGE);
125+
}
126+
113127
protected DatePickerElement getTestField() {
114128
return $(DatePickerElement.class).first();
115129
}

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,22 @@ protected boolean isInputValuePresent() {
579579
return getElement().getProperty("_hasInputValue", false);
580580
}
581581

582+
@Override
583+
public void setValue(LocalDate value) {
584+
LocalDate oldValue = getValue();
585+
586+
super.setValue(value);
587+
588+
if (Objects.equals(oldValue, getEmptyValue())
589+
&& Objects.equals(value, getEmptyValue())
590+
&& isInputValuePresent()) {
591+
// Clear the input element from possible bad input.
592+
getElement().executeJs("this.inputElement.value = ''");
593+
getElement().setProperty("_hasInputValue", false);
594+
fireEvent(new ClientValidatedEvent(this, false, true));
595+
}
596+
}
597+
582598
/**
583599
* Sets the label for the datepicker.
584600
*

‎vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/main/resources/META-INF/resources/frontend/datepickerConnector.js‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,6 @@ import { extractDateParts, parseDate as _parseDate } from '@vaadin/date-picker/s
1818

1919
datepicker.$connector = {};
2020

21-
datepicker.addEventListener(
22-
'blur',
23-
tryCatchWrapper((e) => {
24-
if (!e.target.value && e.target.invalid) {
25-
console.warn('Invalid value in the DatePicker.');
26-
}
27-
})
28-
);
29-
3021
const createLocaleBasedDateFormat = function (locale) {
3122
try {
3223
// Check whether the locale is supported or not

0 commit comments

Comments
 (0)