Skip to content
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

fix: v8 Combobox & Dropdown: add aria-invalid when errorMessage is set #33529

Merged
merged 4 commits into from
Jan 2, 2025
Merged

fix: v8 Combobox & Dropdown: add aria-invalid when errorMessage is set #33529

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d135b4
add aria-invalid to both Dropdown and Combobox
smhigley Dec 30, 2024
077d70b
update snapshots
smhigley Dec 30, 2024
ca043bd
change file
smhigley Dec 30, 2024
67d9a9a
update snapshot
smhigley Jan 2, 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
7 changes: 7 additions & 0 deletions change/@fluentui-react-b9ca80e1-5566-481a-b758-61a5cf7a9c9f.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix(Combobox and Dropdown): add aria-invalid when errorMessage is set",
"packageName": "@fluentui/react",
"email": "[email protected]",
"dependentChangeType": "patch"
}
9 changes: 9 additions & 0 deletions packages/react/src/components/ComboBox/ComboBox.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,15 @@ describe('ComboBox', () => {
expect(combobox.getAttribute('aria-disabled')).toEqual('true');
smhigley marked this conversation as resolved.
Show resolved Hide resolved
});

it('sets alert message and aria-invalid when errorMessage is set', () => {
const { getByRole } = render(
<ComboBox label="Test label" options={DEFAULT_OPTIONS} errorMessage="This is an example error." />,
);
const alert = getByRole('alert');
expect(alert.textContent).toBe('This is an example error.');
expect(getByRole('combobox').getAttribute('aria-invalid')).toBe('true');
});

it('Renders no selected item in default case', () => {
const { getByRole } = render(<ComboBox options={DEFAULT_OPTIONS} />);
expect(getByRole('combobox').getAttribute('value')).toEqual('');
Expand Down
3 changes: 3 additions & 0 deletions packages/react/src/components/ComboBox/ComboBox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,8 @@ class ComboBoxInternal extends React.Component<IComboBoxInternalProps, IComboBox
'aria-label': ariaLabel && !label ? ariaLabel : undefined,
};

const hasErrorMessage = errorMessage && errorMessage.length > 0 ? true : false;

return (
<div
data-ktp-target={true}
Expand Down Expand Up @@ -679,6 +681,7 @@ class ComboBoxInternal extends React.Component<IComboBoxInternalProps, IComboBox
aria-activedescendant={ariaActiveDescendantValue}
aria-required={required}
aria-disabled={disabled}
aria-invalid={hasErrorMessage}
aria-controls={isOpen ? this._id + '-list' : undefined}
spellCheck={false}
defaultVisibleValue={this._currentVisibleValue}
Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/components/ComboBox/__snapshots__/ComboBox.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ exports[`ComboBox Renders correctly 1`] = `
<input
aria-autocomplete="both"
aria-expanded="false"
aria-invalid="false"
autocapitalize="off"
autocomplete="off"
class=
Expand Down Expand Up @@ -495,6 +496,7 @@ exports[`ComboBox Renders correctly when open 1`] = `
aria-autocomplete="both"
aria-controls="ComboBox0-list"
aria-expanded="true"
aria-invalid="false"
autocapitalize="off"
autocomplete="off"
class=
Expand Down Expand Up @@ -1333,6 +1335,7 @@ exports[`ComboBox Renders correctly when opened in multi-select mode 1`] = `
aria-autocomplete="both"
aria-controls="ComboBox0-list"
aria-expanded="true"
aria-invalid="false"
autocapitalize="off"
autocomplete="off"
class=
Expand Down Expand Up @@ -2266,6 +2269,7 @@ exports[`ComboBox renders with a Keytip correctly 1`] = `
aria-autocomplete="both"
aria-describedby="test-foo ktp-layer-id ktp-a"
aria-expanded="false"
aria-invalid="false"
autocapitalize="off"
autocomplete="off"
class=
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/components/Dropdown/Dropdown.base.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ class DropdownInternal extends React.Component<IDropdownInternalProps, IDropdown
aria-describedby={hasErrorMessage ? this._id + '-errorMessage' : undefined}
aria-required={required}
aria-disabled={disabled}
aria-invalid={hasErrorMessage}
aria-controls={isOpen ? this._listId : undefined}
{...divProps}
className={this._classNames.dropdown}
Expand All @@ -391,7 +392,6 @@ class DropdownInternal extends React.Component<IDropdownInternalProps, IDropdown
className={this._classNames.title}
aria-live={hasFocus ? 'polite' : undefined}
aria-atomic={hasFocus ? true : undefined}
aria-invalid={hasErrorMessage}
>
{
// If option is selected render title, otherwise render the placeholder text
Expand Down
3 changes: 2 additions & 1 deletion packages/react/src/components/Dropdown/Dropdown.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -710,12 +710,13 @@ describe('Dropdown', () => {
expect(dropdownRoot.getAttribute('aria-labelledby')).not.toBeNull();
});

it('sets role=error on included error message', () => {
it('sets alert message and aria-invalid when errorMessage is set', () => {
const { getByRole } = render(
<Dropdown label="Test label" options={[]} id="sample-dropdown" errorMessage="This is an example error." />,
);
const alert = getByRole('alert');
expect(alert.textContent).toBe('This is an example error.');
expect(getByRole('combobox').getAttribute('aria-invalid')).toBe('true');
});
});

Expand Down
8 changes: 4 additions & 4 deletions packages/react/src/components/Dropdown/__snapshots__/Dropdown.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ exports[`Dropdown multi-select Renders correctly 1`] = `
<div
aria-expanded="false"
aria-haspopup="listbox"
aria-invalid="false"
class=
ms-Dropdown
{
Expand Down Expand Up @@ -101,7 +102,6 @@ exports[`Dropdown multi-select Renders correctly 1`] = `
tabindex="0"
>
<span
aria-invalid="false"
class=
ms-Dropdown-title
ms-Dropdown-titleIsPlaceHolder
Expand Down Expand Up @@ -939,6 +939,7 @@ exports[`Dropdown multi-select Renders correctly when open 1`] = `
aria-controls="Dropdown0-list"
aria-expanded="true"
aria-haspopup="listbox"
aria-invalid="false"
class=
ms-Dropdown
is-open
Expand Down Expand Up @@ -1034,7 +1035,6 @@ exports[`Dropdown multi-select Renders correctly when open 1`] = `
>
<span
aria-atomic="true"
aria-invalid="false"
aria-live="polite"
class=
ms-Dropdown-title
Expand Down Expand Up @@ -1119,6 +1119,7 @@ exports[`Dropdown single-select Renders correctly 1`] = `
<div
aria-expanded="false"
aria-haspopup="listbox"
aria-invalid="false"
class=
ms-Dropdown
{
Expand Down Expand Up @@ -1212,7 +1213,6 @@ exports[`Dropdown single-select Renders correctly 1`] = `
tabindex="0"
>
<span
aria-invalid="false"
class=
ms-Dropdown-title
ms-Dropdown-titleIsPlaceHolder
Expand Down Expand Up @@ -1295,6 +1295,7 @@ exports[`Dropdown single-select Renders correctly when open 1`] = `
aria-controls="Dropdown0-list"
aria-expanded="true"
aria-haspopup="listbox"
aria-invalid="false"
class=
ms-Dropdown
is-open
Expand Down Expand Up @@ -1390,7 +1391,6 @@ exports[`Dropdown single-select Renders correctly when open 1`] = `
>
<span
aria-atomic="true"
aria-invalid="false"
aria-live="polite"
class=
ms-Dropdown-title
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/components/TimePicker/__snapshots__/TimePicker.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ exports[`TimePicker renders correctly 1`] = `
aria-autocomplete="inline"
aria-describedby="ComboBox0-error"
aria-expanded={false}
aria-invalid={false}
aria-labelledby="ComboBox0-label"
autoCapitalize="off"
autoComplete="off"
Expand Down
Loading