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

Jump to bottom

Improve aria-labels for example icon buttons and add guidance #4191

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Improve aria-labels for example icon buttons and add guidance #4191

merged 2 commits into from
Jan 29, 2024

Conversation

owenniblock
Copy link
Contributor

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

Changes the aria-labels on examples so they are more realistic and better describe the icon button itself. I figured the "Close" button used as the default for the Playground might be a bit confusing so I changed this to "Favorite".

I also updated the docs to include the aria-label property and linked to the help docs on primer.style. Please note that I included the full URL, if there's a better way to add this reference please let me know.

Changelog

New

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

This is a docs change and so I don't believe it requires a version release (please correct me if I'm wrong!)

Testing & Reviewing

Run the storybook & docs site locally to test. Changes can be seen:

Merge checklist

@owenniblock owenniblock added docs Documentation skip changeset This change does not need a changelog labels Jan 29, 2024
@owenniblock owenniblock requested review from keithamus, a team and langermank January 29, 2024 11:40
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 29, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: ae63bdb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 29, 2024 •
edited
Loading

size-limit report 📦

Path Size
dist/browser.esm.js 113.83 KB (0%)
dist/browser.umd.js 114.47 KB (0%)

@github-actions github-actions bot temporarily deployed to storybook-preview-4191 January 29, 2024 11:44 Inactive
keithamus
keithamus approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

LGTM

joshblack
joshblack approved these changes Jan 29, 2024
View reviewed changes
Copy link
Member

@joshblack joshblack left a comment

Choose a reason for hiding this comment

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

🔥 Love it!

@joshblack joshblack added this pull request to the merge queue Jan 29, 2024
Merged via the queue into main with commit bedf114 Jan 29, 2024
30 checks passed
@joshblack joshblack deleted the icon-button-aria-label-improvements branch January 29, 2024 17:16
@owenniblock
Copy link
Contributor Author

Thanks for sorting out the snapshots @joshblack!

pksjce pushed a commit that referenced this pull request Feb 8, 2024
@owenniblock @joshblack @pksjce
Improve aria-labels for example icon buttons and add guidance (#4191)
5d47efb 
* Improve aria-labels for example icon buttons and add guidance

* test(vrt): update snapshots

---------

Co-authored-by: joshblack <joshblack@users.noreply.github.com>
github-merge-queue bot pushed a commit that referenced this pull request Feb 12, 2024
@pksjce @dependabot
@owenniblock @joshblack @langermank @primer @github-actions
Tentative focus fix in action list item (#4166)
c66b808 
* Tentative focus fix in action list item

* Update snapshots

* Create purple-bees-warn.md

* chore(deps-dev): bump @babel/cli from 7.22.10 to 7.23.9 (#4189)

Bumps [@babel/cli](https://github.com/babel/babel/tree/HEAD/packages/babel-cli) from 7.22.10 to 7.23.9.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.9/packages/babel-cli)

---
updated-dependencies:
- dependency-name: "@babel/cli"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump terser from 5.17.6 to 5.27.0 (#4187)

Bumps [terser](https://github.com/terser/terser) from 5.17.6 to 5.27.0.
- [Changelog](https://github.com/terser/terser/blob/master/CHANGELOG.md)
- [Commits](terser/terser@v5.17.6...v5.27.0)

---
updated-dependencies:
- dependency-name: terser
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump @storybook/source-loader from 7.6.7 to 7.6.10 (#4186)

Bumps [@storybook/source-loader](https://github.com/storybookjs/storybook/tree/HEAD/code/lib/source-loader) from 7.6.7 to 7.6.10.
- [Release notes](https://github.com/storybookjs/storybook/releases)
- [Changelog](https://github.com/storybookjs/storybook/blob/next/CHANGELOG.md)
- [Commits](https://github.com/storybookjs/storybook/commits/v7.6.10/code/lib/source-loader)

---
updated-dependencies:
- dependency-name: "@storybook/source-loader"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Improve aria-labels for example icon buttons and add guidance (#4191)

* Improve aria-labels for example icon buttons and add guidance

* test(vrt): update snapshots

---------

Co-authored-by: joshblack <joshblack@users.noreply.github.com>

* chore(deps): bump @github/combobox-nav from 2.1.7 to 2.3.1 (#4185)

* chore(deps): bump @github/combobox-nav from 2.1.7 to 2.3.1

Bumps [@github/combobox-nav](https://github.com/github/combobox-nav) from 2.1.7 to 2.3.1.
- [Release notes](https://github.com/github/combobox-nav/releases)
- [Commits](github/combobox-nav@v2.1.7...v2.3.1)

---
updated-dependencies:
- dependency-name: "@github/combobox-nav"
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

* test: add fallback for Element#scrollIntoView

* chore: fix eslint warning

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Josh Black <joshblack@users.noreply.github.com>

* Add missing CSS vars to legacy-theme (#4193)

* oof

* Create thirty-mirrors-switch.md

* test(vrt): update snapshots

* fix missing var

* fix parens

* test(vrt): update snapshots

---------

Co-authored-by: langermank <langermank@users.noreply.github.com>

* Version Packages (#4183)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Owen Niblock <owenniblock@github.com>
Co-authored-by: joshblack <joshblack@users.noreply.github.com>
Co-authored-by: Katie Langerman <18661030+langermank@users.noreply.github.com>
Co-authored-by: langermank <langermank@users.noreply.github.com>
Co-authored-by: primer[bot] <119360173+primer[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshblack joshblack joshblack approved these changes

@keithamus keithamus keithamus approved these changes

@langermank langermank Awaiting requested review from langermank

Assignees
No one assigned
Labels
docs Documentation skip changeset This change does not need a changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@owenniblock @keithamus @joshblack