feat: add i18n error message support for TextField #6343

vursen · 2024-06-03T14:04:33Z

Description

The PR introduces TextFieldI18n with methods for setting error messages and updates the TextField's validation logic to show these error messages when validation fails.

Note

It's still possible to use the setErrorMessage method to configure a single static error message. This error message will be displayed for all constraints and will take priority over any i18n error messages that are also set. However, when more than one error message is needed, i18n should be used or manual validation mode should be enabled.

Depends on

refactor(ValidationUtil): add methods accepting error message, deprecate old ones #6322

Part of #4618

Type of change

Feature

vursen · 2024-06-04T09:40:11Z

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java

+         *
+         * @return the error message or {@code null} if not set
+         * @see TextField#isRequiredIndicatorVisible()
+         * @see TextField#setRequiredIndicatorVisible(boolean)


question: Should we mention isRequired() and setRequired(boolean) here as well?

vursen · 2024-06-10T08:06:30Z

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java

+
+        ValidationResult maxLengthResult = ValidationUtil
+                .validateMaxLengthConstraint(getMaxLengthErrorMessage(), value,
+                        hasMaxLength() ? getMaxLength() : null);


note: getMaxLength() returns 0 if the maxLength property is null. I added this check to ensure the max length is only considered when the user has explicitly set it with setMinLength(int minLength).

...adin-flow-components-base/src/main/java/com/vaadin/flow/component/shared/ValidationUtil.java

tomivirkki · 2024-06-10T10:43:25Z

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java

+            }
+        }
+
+        ValidationResult maxLengthResult = ValidationUtil


I wonder if it would make sense to reuse validateMaxConstraint?

ValidationResult maxLengthResult = ValidationUtil.validateMaxConstraint( getMaxLengthErrorMessage(), value.length(), hasMaxLength() ? getMaxLength() : null);

Hmm, I didn’t think about that. Thanks. I personally don't have a strong opinion on which way is better.

To keep it consistent, I guess we should also use validateMinConstraint for minLength. If we use it, we will need to add a check outside the validator to see if the value is an empty string to not run the validator then.

I don't have a strong preference for either approach so this isn't a blocker for the PR

sonarcloud · 2024-06-10T12:57:43Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

checkRequired => validateRequiredConstraint add unit test polish run formatter docs: improve grid empty state documentation (#6351) add more unit tests wip

DiegoCardoso · 2024-07-15T08:07:01Z

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java

+    private String getRequiredErrorMessage() {
+        return Optional.ofNullable(i18n)
+                .map(TextFieldI18n::getRequiredErrorMessage).orElse("");
+    }
+
+    private String getMinLengthErrorMessage() {
+        return Optional.ofNullable(i18n)
+                .map(TextFieldI18n::getMinLengthErrorMessage).orElse("");
+    }
+
+    private String getMaxLengthErrorMessage() {
+        return Optional.ofNullable(i18n)
+                .map(TextFieldI18n::getMaxLengthErrorMessage).orElse("");
+    }
+
+    private String getPatternErrorMessage() {
+        return Optional.ofNullable(i18n)
+                .map(TextFieldI18n::getPatternErrorMessage).orElse("");
+    }


Could use the same approach as suggested in #6365 (comment)

Thanks, updated.

vursen · 2024-07-17T13:12:21Z

During our internal discussion, we discovered a way to keep error messages that are set with setErrorMessage. They now take priority over i18n error messages, which allows developers to continue using the old familiar method, setting a single error message for all constraints. I've updated the PR and also removed the breaking change mark.

sissbruecker · 2024-07-18T09:20:58Z

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java


    private boolean manualValidationEnabled = false;

+    private String customErrorMessage;
+    private String constraintErrorMessage;


What do you think about extracting this somehow? There could be a class that:

Manages custom + constraint error message states

Updates the effective error message property on the component when either is set

It wouldn't do a whole lot, but it looks like you have to replicate the logic quite a few times for different components. There's also checkValidity which is always the same though that one needs to access more stuff from the component. Anyway, maybe something to think about, we can also do this after updating all components and then see if there is something that works for all of them.

Are you suggesting extracting this only for text fields or for all field components?

I guess we could have something like ErrorMessageController:

class ErrorMessageController { private Component component; public ErrorMessageController(Component component) { this.component = component; } public void setCustomErrorMessage() { ... this.updateErrorMessageProperty(); } public void setConstraintErrorMessage() { ... this.updateErrorMessageProperty(); } private void updateErrorMessageProperty() { this.component.getElement().setProperty("errorMessage"); } }

There's also checkValidity which is always the same though that one needs to access more stuff from the component.

I discussed this with @yuriy-fix some time ago, and we concluded that it would currently complicate things especially since the whole i18n would need to be passed to that helper class or the class would need to provide an API to abstract itself from i18n. We agreed to revisit this in the future when we get to implementing error message providers.

Yep, something like what you suggested with the controller. It seems like that would be applicable to all components, but not sure. But since there are other potential opportunities for code reuse, let's maybe finish changing the components first, and then see what we can extract as common logic?

Agreed 👍

...rent/vaadin-text-field-flow/src/main/java/com/vaadin/flow/component/textfield/TextField.java

sonarcloud · 2024-07-18T14:37:14Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

vaadin-bot · 2024-07-30T12:09:08Z

This ticket/PR has been released with Vaadin 24.5.0.alpha6 and is also targeting the upcoming stable 24.5.0 version.

vursen changed the title ~~feat: add support for error messages with TextFieldI18n~~ feat: support error messages with TextFieldI18n Jun 3, 2024

vursen changed the title ~~feat: support error messages with TextFieldI18n~~ feat: support setting error messages with TextFieldI18n Jun 3, 2024

vursen force-pushed the feat/text-field/error-messages branch from 7b20ca4 to 7361585 Compare June 3, 2024 14:15

vursen changed the title ~~feat: support setting error messages with TextFieldI18n~~ feat!: support setting error messages with TextFieldI18n Jun 3, 2024

vursen force-pushed the feat/text-field/error-messages branch 2 times, most recently from 24eb2a5 to 1f71052 Compare June 3, 2024 19:25

vursen commented Jun 4, 2024

View reviewed changes

vursen force-pushed the feat/text-field/error-messages branch 5 times, most recently from 96bb60e to 3f8e7d5 Compare June 7, 2024 13:18

vursen marked this pull request as ready for review June 10, 2024 06:40

vursen commented Jun 10, 2024

View reviewed changes

vursen requested review from tomivirkki, yuriy-fix and DiegoCardoso June 10, 2024 08:23

tomivirkki reviewed Jun 10, 2024

View reviewed changes

tomivirkki approved these changes Jun 10, 2024

View reviewed changes

vursen requested review from sissbruecker and DiegoCardoso and removed request for yuriy-fix and DiegoCardoso July 11, 2024 08:17

vursen force-pushed the feat/text-field/error-messages branch from 50091ff to 5911e46 Compare July 11, 2024 11:38

vursen added 4 commits July 11, 2024 15:51

feat!: support setting error messages with TextFieldI18n

c40f9ef

checkRequired => validateRequiredConstraint add unit test polish run formatter docs: improve grid empty state documentation (#6351) add more unit tests wip

align JavaDoc wording

5184274

fix typos in JavaDoc

fb112d6

update JavaDoc

9b255ba

vursen force-pushed the feat/text-field/error-messages branch from 5911e46 to 9b255ba Compare July 11, 2024 11:51

DiegoCardoso reviewed Jul 15, 2024

View reviewed changes

vursen added 2 commits July 15, 2024 12:48

replace multiple helpers with one

22222b7

do not override custom error messages with i18n ones

1a4c180

vursen changed the title ~~feat!: support setting error messages with TextFieldI18n~~ feat: support setting error messages with TextFieldI18n Jul 17, 2024

vursen requested a review from DiegoCardoso July 17, 2024 13:25

vursen added 2 commits July 17, 2024 16:25

Merge branch 'main' into feat/text-field/error-messages

414f511

set an empty error message when valid

5f3d1cd

vursen requested review from sissbruecker and removed request for sissbruecker July 18, 2024 08:43

remove no longer relevant note from HasValidationProperties

58ccd04

sissbruecker reviewed Jul 18, 2024

View reviewed changes

improve JavaDoc for validate() method

ca09fe0

sissbruecker approved these changes Jul 18, 2024

View reviewed changes

Merge branch 'main' into feat/text-field/error-messages

66a9dc6

vursen changed the title ~~feat: support setting error messages with TextFieldI18n~~ feat: add i18n error message support for TextField Jul 19, 2024

vursen merged commit a7a723f into main Jul 19, 2024
5 checks passed

vursen deleted the feat/text-field/error-messages branch July 19, 2024 05:52

vaadin-bot added prerelease version for Vaadin 24.5.0 Released with Vaadin 24.5.0.alpha6 labels Jul 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add i18n error message support for TextField #6343

feat: add i18n error message support for TextField #6343

vursen commented Jun 3, 2024 •

edited

Loading

vursen Jun 4, 2024 •

edited

Loading

vursen Jun 10, 2024 •

edited

Loading

tomivirkki Jun 10, 2024

vursen Jun 10, 2024 •

edited

Loading

tomivirkki Jun 10, 2024

sonarcloud bot commented Jun 10, 2024

DiegoCardoso Jul 15, 2024

vursen Jul 15, 2024 •

edited

Loading

vursen commented Jul 17, 2024 •

edited

Loading

sissbruecker Jul 18, 2024

vursen Jul 18, 2024

vursen Jul 18, 2024 •

edited

Loading

vursen Jul 18, 2024 •

edited

Loading

sissbruecker Jul 18, 2024

vursen Jul 18, 2024

sonarcloud bot commented Jul 18, 2024

vaadin-bot commented Jul 30, 2024

feat: add i18n error message support for TextField #6343

feat: add i18n error message support for TextField #6343

Conversation

vursen commented Jun 3, 2024 • edited Loading

Description

Type of change

vursen Jun 4, 2024 • edited Loading

Choose a reason for hiding this comment

vursen Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

tomivirkki Jun 10, 2024

Choose a reason for hiding this comment

vursen Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

tomivirkki Jun 10, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Jun 10, 2024

Quality Gate passed

DiegoCardoso Jul 15, 2024

Choose a reason for hiding this comment

vursen Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

vursen commented Jul 17, 2024 • edited Loading

sissbruecker Jul 18, 2024

Choose a reason for hiding this comment

vursen Jul 18, 2024

Choose a reason for hiding this comment

vursen Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

vursen Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

sissbruecker Jul 18, 2024

Choose a reason for hiding this comment

vursen Jul 18, 2024

Choose a reason for hiding this comment

sonarcloud bot commented Jul 18, 2024

Quality Gate passed

vaadin-bot commented Jul 30, 2024

vursen commented Jun 3, 2024 •

edited

Loading

vursen Jun 4, 2024 •

edited

Loading

vursen Jun 10, 2024 •

edited

Loading

vursen Jun 10, 2024 •

edited

Loading

vursen Jul 15, 2024 •

edited

Loading

vursen commented Jul 17, 2024 •

edited

Loading

vursen Jul 18, 2024 •

edited

Loading

vursen Jul 18, 2024 •

edited

Loading