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.

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

Follow button enhancements #14356

Open
aitchiss opened this issue Jul 27, 2021 · 12 comments
Open

Follow button enhancements #14356

aitchiss opened this issue Jul 27, 2021 · 12 comments
Labels
area: accessibility issues that need accessibility improvements (a11y) external contributors welcome contribution is welcome!

Comments

@aitchiss
Copy link
Contributor

There are some small improvements we could make to Follow buttons in the app (these areas could be addressed in separate, smaller PRs):

1. Give the buttons more descriptive accessible names

  • At the moment we have a lot of buttons in the UI with the text "Follow", and it's difficult for screen reader users to tell them apart without the visual context
  • All follow buttons should have an accessible name of the format e.g. "Follow user: Admin McAdmin" / "Follow tag: beginners"
  • The visible button text should not be affected
  • Accessible name could be influenced by hidden text (using screen-reader-only class on a span), or by employing aria-labels. Visually hidden text is usually preferable since it allows for browser translation to other languages.

2. Make the buttons toggle buttons so that state is accurately conveyed to screen reader users

  • At the moment, if you are using a screen reader and click a follow button, there is no feedback to confirm the action has succeeded. The button text changes to "Following" but a screen reader user will not hear that announced unless they tab away and come back to the button
  • We can make the buttons toggle buttons, and use aria-pressed to convey the following state, e.g. a follow button with aria-pressed="true" communicates that the button is in the "Followed" state
  • The "accessible name" of these buttons should always remain as "Follow" (or "Follow back") regardless of the visually displayed text

3. Display 'Unfollow' when you hover over a 'Following' button, to better visually convey the action that will happen on click

  • see this loom from @msarit for more detail
  • NB: This is similar to how we display bookmarked articles in the home feed - the button reads "Saved" until you hover over it, at which point it shows the action "Unsave"
@aitchiss aitchiss added the area: accessibility issues that need accessibility improvements (a11y) label Jul 27, 2021
@github-actions
Copy link
Contributor

Thanks for the issue, we will take it into consideration! Our team of engineers is busy working on many types of features, please give us time to get back to you.

Feature requests that require more discussion may be closed. Read more about our feature request process on forem.dev.

To our amazing contributors: issues labeled type: bug are always up for grabs, but for feature requests, please wait until we add a ready for dev before starting to work on it.

To claim an issue to work on, please leave a comment. If you've claimed the issue and need help, please ping @forem/oss. The OSS Community Manager or the engineers on OSS rotation will follow up.

For full info on how to contribute, please check out our contributors guide.

@aitchiss aitchiss added the external contributors welcome contribution is welcome! label Jul 27, 2021
@keshavbiswa
Copy link
Contributor

I'll take this 🙂 @aitchiss

@rhymes
Copy link
Contributor

rhymes commented Jul 28, 2021

@keshavbiswa assigned to you

@Link2Twenty
Copy link
Contributor

What's left to do for this one?

@aitchiss
Copy link
Contributor Author

Hey @Link2Twenty it's just point 3 that we haven't addressed yet:

  1. Display 'Unfollow' when you hover over a 'Following' button, to better visually convey the action that will happen on click

@keshavbiswa
Copy link
Contributor

keshavbiswa commented Sep 27, 2021

What's left to do for this one?

I'm actually currently working on completing point 3 😓. Taking a bit longer than expected I guess.

@aitchiss
Copy link
Contributor Author

Yay! No worries @keshavbiswa - it's not been very long at all! There's absolutely no rush, glad to hear you're happy to continue on this issue 😄

@Link2Twenty
Copy link
Contributor

Sorry @keshavbiswa I wasn't meant to make you feel pressured, I'm just having a look at what's open 😊

@doniarobinson
Copy link

doniarobinson commented Oct 21, 2023

@aitchiss Are you still interested in having # 3 completed? I also noticed that the bookmarked articles (Saved/Unsaved) no longer work the way you describe, so that might be another task to complete? I'm looking for some Hacktoberfest items to try out. (Long time developer, just haven't open sourced.) Thanks!

@keshavbiswa
Copy link
Contributor

I apologize, it has been more than 2 years and it's still assigned to me and I forgot 🙏

@keshavbiswa
Copy link
Contributor

@doniarobinson, if you're interested, I'll unassign myself from this and you can work on it.

@doniarobinson
Copy link

That would be terrific @keshavbiswa Thanks!

@keshavbiswa keshavbiswa removed their assignment Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: accessibility issues that need accessibility improvements (a11y) external contributors welcome contribution is welcome!
Projects
None yet
Development

No branches or pull requests

5 participants