Skip to content

fix: issues with form controls not showing proper valid state #3939

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

Merged
nmerget merged 7 commits into from
Apr 3, 2025
Merged

fix: issues with form controls not showing proper valid state #3939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
43acdbb
fix: issues with form controls not showing proper valid state
nmerget Mar 13, 2025
ab44e7e
fix: linting issue
nmerget Mar 13, 2025
40b2dd7
chore: update snapshots
nmerget Mar 13, 2025
597764d
Merge branch 'main' into fix-form-validations
nmerget Mar 14, 2025
05cc5b3
Merge branch 'main' into fix-form-validations
nmerget Mar 31, 2025
69094dd
Merge branch 'main' into fix-form-validations
mfranzke Apr 2, 2025
3444f1b
Merge branch 'main' into fix-form-validations
nmerget Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified __snapshots__/checkbox/patternhub/checkbox-properties-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...hContrast/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions ...m-highContrast/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@
- textbox "Label"
- status
- text: x_placeholder" / "
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -148,9 +158,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
Binary file modified .../chromium/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions ...wcase/chromium/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@
- textbox "Label"
- status
- text: x_placeholder" / "
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -148,9 +158,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
Binary file modified ...e/firefox/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions ...owcase/firefox/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,16 @@
- text: Label
- textbox "Label"
- status
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -147,9 +157,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
Binary file modified ...le-chrome/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions .../mobile-chrome/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@
- textbox "Label"
- status
- text: x_placeholder" / "
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -148,9 +158,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
Binary file modified ...le-safari/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions .../mobile-safari/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@
- textbox "Label"
- status
- text: x_placeholder" / "
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -148,9 +158,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
Binary file modified ...se/webkit/DBInput-should-match-screenshot-1/DBInput-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions ...howcase/webkit/should-have-same-aria-snapshot/DBInput-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@
- textbox "Label"
- status
- text: x_placeholder" / "
- link "Example - Length arrow_up_right\" / \""
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
- textbox "Label"
- status
- link "Example - Types arrow_up_right\" / \""
- text: Label
- textbox "Label"
Expand Down Expand Up @@ -148,9 +158,6 @@
- textbox "Label"
- status
- text: Label
- spinbutton "Label"
- status
- text: Label
- textbox "Label"
- status
- text: Label
Expand Down
70 changes: 39 additions & 31 deletions packages/components/src/components/checkbox/checkbox.lite.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,34 +52,26 @@ export default function DBCheckbox(props: DBCheckboxProps) {
_invalidMessageId: undefined,
_descByIds: '',
_voiceOverFallback: '',
handleChange: (event: ChangeEvent<HTMLInputElement>) => {
if (props.onChange) {
props.onChange(event);
}

if (props.change) {
props.change(event);
}

useTarget({
angular: () =>
handleFrameworkEventAngular(this, event, 'checked'),
vue: () => handleFrameworkEventVue(() => {}, event, 'checked')
});

_invalidMessage: '',
hasValidState: () => {
return !!(props.validMessage ?? props.validation === 'valid');
},
handleValidation: () => {
/* For a11y reasons we need to map the correct message with the checkbox */
if (!_ref?.validity.valid || props.validation === 'invalid') {
state._descByIds = state._invalidMessageId;
state._invalidMessage =
props.invalidMessage ||
_ref?.validationMessage ||
DEFAULT_INVALID_MESSAGE;
if (hasVoiceOver()) {
state._voiceOverFallback =
props.invalidMessage ??
_ref?.validationMessage ??
DEFAULT_INVALID_MESSAGE;
state._voiceOverFallback = state._invalidMessage;
delay(() => (state._voiceOverFallback = ''), 1000);
}
} else if (
props.validation === 'valid' ||
(_ref?.validity.valid && props.required)
state.hasValidState() &&
_ref?.validity.valid &&
props.required
) {
state._descByIds = state._validMessageId;
if (hasVoiceOver()) {
Expand All @@ -93,6 +85,22 @@ export default function DBCheckbox(props: DBCheckboxProps) {
state._descByIds = '';
}
},
handleChange: (event: ChangeEvent<HTMLInputElement>) => {
if (props.onChange) {
props.onChange(event);
}

if (props.change) {
props.change(event);
}

useTarget({
angular: () =>
handleFrameworkEventAngular(this, event, 'checked'),
vue: () => handleFrameworkEventVue(() => {}, event, 'checked')
});
state.handleValidation();
},
handleBlur: (event: InteractionEvent<HTMLInputElement>) => {
if (props.onBlur) {
props.onBlur(event);
Expand Down Expand Up @@ -120,6 +128,7 @@ export default function DBCheckbox(props: DBCheckboxProps) {
state._messageId = mId + DEFAULT_MESSAGE_ID_SUFFIX;
state._validMessageId = mId + DEFAULT_VALID_MESSAGE_ID_SUFFIX;
state._invalidMessageId = mId + DEFAULT_INVALID_MESSAGE_ID_SUFFIX;
state._invalidMessage = props.invalidMessage || DEFAULT_INVALID_MESSAGE;
});

onUpdate(() => {
Expand Down Expand Up @@ -213,21 +222,20 @@ export default function DBCheckbox(props: DBCheckboxProps) {
{props.message}
</DBInfotext>
</Show>

<DBInfotext
id={state._validMessageId}
size="small"
semantic="successful">
{props.validMessage ?? DEFAULT_VALID_MESSAGE}
</DBInfotext>
<Show when={state.hasValidState()}>
<DBInfotext
id={state._validMessageId}
size="small"
semantic="successful">
{props.validMessage || DEFAULT_VALID_MESSAGE}
</DBInfotext>
</Show>

<DBInfotext
id={state._invalidMessageId}
size="small"
semantic="critical">
{props.invalidMessage ??
_ref?.validationMessage ??
DEFAULT_INVALID_MESSAGE}
{state._invalidMessage}
</DBInfotext>

{/* * https://www.davidmacd.com/blog/test-aria-describedby-errormessage-aria-live.html
Expand Down
4 changes: 3 additions & 1 deletion packages/components/src/components/checkbox/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
FormMessageProps,
FormProps,
FormState,
FromValidState,
GlobalProps,
GlobalState,
InitializedState,
Expand Down Expand Up @@ -36,4 +37,5 @@ export type DBCheckboxState = DBCheckboxDefaultState &
ChangeEventState<HTMLInputElement> &
FocusEventState<HTMLInputElement> &
FormState &
InitializedState;
InitializedState &
FromValidState;
Loading
Loading