Add aria-label to Spinner component

[owenniblock]

Closes https://github.com/github/primer/issues/2202

This adds a new option for setting the accessible label of the Spinner component. When it's not provided, we default to "Loading" so you have to intentionally hide the element with label="". Where we find Loading state is communicated to screenreader users twice in dotcom, we can set this label value to "", I have intentionally opted for the most accessible default so it over communicates rather than under-communicating the loading state.

Changelog

New

label option on Spinner component. Defaults to "Loading". When set (or left as default) it adds aria-label={label} to the Spinner's svg.

Adds role="img" to the svg element.

If the label is set to an empty string, it adds aria-hidden='true' to the svg element.

Changed

Removed

Rollout strategy

• Patch release
• Minor release
• Major release; if selected, include a written rollout or migration plan
• None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

• Added/updated tests
• Added/updated documentation
• Added/updated previews (Storybook)
• Changes are SSR compatible
• Tested in Chrome
• Tested in Firefox
• Tested in Safari
• Tested in Edge
• (GitHub staff only) Integration tests pass at github/github (Learn more about how to run integration tests)

[changeset-bot]

🦋 Changeset detected

Latest commit: 5f711be

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@primer/react	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

size-limit report 📦

Path	Size
dist/browser.esm.js	113.25 KB (+0.03% 🔺)
dist/browser.umd.js	113.91 KB (+0.05% 🔺)

[owenniblock]

So interestingly, the loading spinner is used on TextInput (via TextInputInnerVisualSlot) - need to work out whether we want to make it aria-hidden or not 🤔

We can see this on the deployed storybook page

[broccolinisoup]

Hello @owenniblock 👋🏻 We have an open [github.com/github/primer/discussions/2976](Spinner API discussion) that @mperrotti created, sorry if you already know about it or discussed it somewhere else. I just wanted to make sure to link them and would love to understand their overlap.

Thank you!! 🙏🏻

[owenniblock]

@broccolinisoup I had not seen that, thanks for bringing it to my attention!

[owenniblock]

Converting to draft because there's ongoing discussions about this component.

[owenniblock]

Going to close this. We need to handle it differently anyway!