Skip to content

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

Merged
joshblack merged 2 commits into
mainfrom
icon-button-aria-label-improvements
Jan 29, 2024
Merged

Improve aria-labels for example icon buttons and add guidance#4191
joshblack merged 2 commits into
mainfrom
icon-button-aria-label-improvements

Conversation

@owenniblock

@owenniblockowenniblock commented Jan 29, 2024

Copy link
Copy Markdown
Contributor

Closeshttps://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

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

changeset-botBot commented Jan 29, 2024•
edited
Loading

Copy link
Copy Markdown

⚠️ 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-actionsBot commented Jan 29, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
dist/browser.esm.js113.83 KB (0%)
dist/browser.umd.js114.47 KB (0%)

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

@keithamuskeithamus left a comment

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.

LGTM

joshblack
joshblack approved these changes Jan 29, 2024
View reviewed changes

@joshblackjoshblack left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔥 Love it!

@joshblackjoshblack added the update snapshots 🤖 Command that updates VRT snapshots on the pull request label Jan 29, 2024
@github-actionsgithub-actionsBot removed the update snapshots 🤖 Command that updates VRT snapshots on the pull request label Jan 29, 2024
@github-actions
github-actionsBottemporarily deployed to storybook-preview-4191 January 29, 2024 16:47 Inactive
@joshblack
joshblack added this pull request to the merge queueJan 29, 2024
Merged via the queue into main with commit bedf114Jan 29, 2024
@joshblack
joshblack deleted the icon-button-aria-label-improvements branch January 29, 2024 17:16
@owenniblock

owenniblock commented Jan 29, 2024

Copy link
Copy Markdown
ContributorAuthor

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-queueBot 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joshblackjoshblackjoshblack approved these changes
@langermanklangermankAwaiting requested review from langermank
+1 more reviewer
@keithamuskeithamuskeithamus approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentationskip changesetThis 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