Skip to content

fix(Spinner): define default aria-label via destructuring #12420

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

Open
mvanhorn wants to merge 7 commits into
base: main
Choose a base branch
from
+47 −7
Open

fix(Spinner): define default aria-label via destructuring #12420

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bd7e869
fix(Spinner): define default aria-label via destructuring
mvanhorn May 8, 2026
ffe889d
test(Spinner): drop aria-labelledBy test asserting non-spec casing
mvanhorn May 9, 2026
958ee89
test(Spinner): use toHaveAccessibleName and cover aria-labelledby coe…
mvanhorn Jul 9, 2026
fc9e371
test(Spinner): address review feedback on aria tests
mvanhorn Jul 15, 2026
a0e3104
test(Spinner): assert accessible name instead of aria-label attribute
mvanhorn Jul 17, 2026
c3e7514
fix(Spinner): address review nits and emit the legacy aria-labelledBy…
mvanhorn Jul 25, 2026
7b4b254
fix(Spinner): deprecate aria-labelledBy and add aria-labelledby
mvanhorn Jul 29, 2026
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
5 changes: 2 additions & 3 deletions packages/react-core/src/components/Spinner/Spinner.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const Spinner: React.FunctionComponent<SpinnerProps> = ({
'aria-valuetext': ariaValueText = 'Loading...',
diameter,
isInline = false,
'aria-label': ariaLabel,
'aria-label': ariaLabel = 'Contents',
'aria-labelledBy': ariaLabelledBy,
...props
}: SpinnerProps) => (
Expand All @@ -42,9 +42,8 @@ export const Spinner: React.FunctionComponent<SpinnerProps> = ({
aria-valuetext={ariaValueText}
viewBox="0 0 100 100"
{...(diameter && { style: { [cssDiameter.name]: diameter } as React.CSSProperties })}
{...(ariaLabel && { 'aria-label': ariaLabel })}
aria-label={ariaLabel}
{...(ariaLabelledBy && { 'aria-labelledBy': ariaLabelledBy })}
{...(!ariaLabel && !ariaLabelledBy && { 'aria-label': 'Contents' })}
{...props}
>
<circle className={styles.spinnerPath} cx="50" cy="50" r="45" fill="none" />
Expand Down
26 changes: 25 additions & 1 deletion packages/react-core/src/components/Spinner/__tests__/Spinner.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
import { render } from '@testing-library/react';
import { render, screen } from '@testing-library/react';
import { Spinner } from '../Spinner';

test('simple spinner', () => {
const { asFragment } = render(<Spinner />);
expect(asFragment()).toMatchSnapshot();
});

test('uses default aria-label of "Contents" when none is provided', () => {
render(<Spinner />);
expect(screen.getByRole('progressbar')).toHaveAccessibleName('Contents');
});

test('uses a custom aria-label when one is provided', () => {
render(<Spinner aria-label="Loading users" />);
expect(screen.getByRole('progressbar')).toHaveAccessibleName('Loading users');
});

test('keeps the default aria-label when aria-labelledby is provided', () => {

@thatblindgeye thatblindgeye Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Renders with accessible name via aria-labelledby when passed" might be slightly more fitting test name here.

render(
<>
<span id="spinner-label">Loading reports</span>
<Spinner aria-labelledby="spinner-label" />
</>
);

const spinner = screen.getByRole('progressbar');
expect(spinner).toHaveAttribute('aria-label', 'Contents');
expect(spinner).toHaveAttribute('aria-labelledby', 'spinner-label');

@thatblindgeye thatblindgeye Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we separate the aria-label check into a separate test, "Renders with aria-label even when aria-labelledby is passed".

Then we can also remove the toHaveAttribute('aria-labelledby'... line; the check for the accessible name should suffice for ensuring aria-labelledby has the expected value.

expect(spinner).toHaveAccessibleName('Loading reports');
});
Comment thread
coderabbitai[bot] marked this conversation as resolved.

test('small spinner', () => {
const { asFragment } = render(<Spinner size="sm" />);
expect(asFragment()).toMatchSnapshot();
Expand Down