New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(DatePicker, TimePicker): explain constraint validation #6537

Merged

vursen merged 34 commits into main from improve-date-picker-validation-docs

Sep 17, 2024

Contributor

vursen commented Aug 12, 2024 •

edited

Loading

Description

Give a general description of how the constraint validation works, including such aspects as validation triggers, constraints, error messages, Binder, manual validation.
For setErrorMessage, mention i18n as the means for setting distinct error messages.
For setErrorMessage, explain that the error message will be only displayed when the field is
For constraint methods like setMin, setMax, mention that they are inclusive.

Part of #6545

Type of change

Docs

vursen changed the title ~~docs(DatePicker): add brief introduction into constraint validation~~ docs(DatePicker): explain how to manage constraint validation

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen force-pushed the improve-date-picker-validation-docs branch from 86a234a to 4da7850 Compare

August 12, 2024 12:59

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen marked this pull request as ready for review

August 12, 2024 13:03

vursen requested a review from rolfsmeds

August 12, 2024 13:03

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          docs: add brief introduction into validation

41bec0b

vursen force-pushed the improve-date-picker-validation-docs branch from d1efaec to 41bec0b Compare

August 13, 2024 05:25


          change h3 to h2

a41a6b0

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Show resolved Hide resolved

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

5fbaee7

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

8a30a76

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

1eabdbc

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

8011a85

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

4cd86d5

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java

vursen commented

View reviewed changes

...t/vaadin-date-picker-flow/src/main/java/com/vaadin/flow/component/datepicker/DatePicker.java Outdated Show resolved Hide resolved

vursen added 4 commits

August 14, 2024 17:21


          Update vaadin-date-picker-flow-parent/vaadin-date-picker-flow/src/mai…

8a93c9e

…n/java/com/vaadin/flow/component/datepicker/DatePicker.java


          format

a2ef2b3


          add a mention of Binder

b808309


          polish

64ad6eb


          align description

9843b90

rolfsmeds requested changes

View reviewed changes

Contributor

rolfsmeds left a comment

See my comments in the corresponding TextField PR :)

vursen added 3 commits

August 26, 2024 12:22


          address code review comments

37130e5


          format

3a8ca05


          revert unintended change

b41d77f

Contributor Author

vursen commented Aug 26, 2024

See my comments in the corresponding TextField PR :)

Updated DatePicker based on the TextField PR.

vursen requested a review from rolfsmeds

August 27, 2024 06:50

vursen added 4 commits

August 28, 2024 14:44


          align with NumberField, reduce redundancy

4d319da


          remove unnecessary JavaDoc annotations, add return annotation

48dc9be


          update required docs

5551c58


          align with ComboBox

d6c41a1

vursen mentioned this pull request

Improve JavaDoc to explain field constraint validation #6545

Open


          add TimePicker

ce16318

vursen changed the title ~~docs(DatePicker): explain how to manage constraint validation~~ docs(DatePicker, TimePicker): explain how to manage constraint validation


          remove unused import

eb6b138

vursen changed the title ~~docs(DatePicker, TimePicker): explain how to manage constraint validation~~ docs(DatePicker, TimePicker): explain constraint validation

vursen requested a review from web-padawan

September 12, 2024 06:43

web-padawan approved these changes

View reviewed changes


          use 'for this field' consistently in getters and setters

447e78e

web-padawan approved these changes

View reviewed changes

web-padawan and others added 2 commits

September 17, 2024 12:17


          Merge branch 'main' into improve-date-picker-validation-docs

739c52c


          simplify @return annotations

28be0ce

web-padawan approved these changes

View reviewed changes

vursen enabled auto-merge (squash)

September 17, 2024 09:34

vursen removed the request for review from yuriy-fix

September 17, 2024 10:03

rolfsmeds approved these changes

View reviewed changes


          Merge branch 'main' into improve-date-picker-validation-docs

831aa4a

sonarcloud bot commented Sep 17, 2024

Quality Gate failed

Failed conditions
22.0% Duplication on New Code (required ≤ 10%)

See analysis details on SonarCloud

vursen merged commit 932ae68 into main

4 of 5 checks passed

vursen deleted the improve-date-picker-validation-docs branch

September 17, 2024 12:23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet