Skip to content

LG-8894: Describe personal key example for assistive technology#7965

Merged
aduth merged 2 commits intomainfrom
aduth-lg-8894-personal-key-example
Mar 10, 2023
Merged

LG-8894: Describe personal key example for assistive technology#7965
aduth merged 2 commits intomainfrom
aduth-lg-8894-personal-key-example

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Mar 10, 2023

🎫 Ticket

LG-8894

🛠 Summary of changes

Adds a non-visible text element describing the personal key example shown with placeholder characters, so that a user can understand what is being shown is an example personal key, instead of having "X" announced 16 times.

📜 Testing Plan

  1. Reset password via "Forgot your password?" on the Sign In screen for a verified account
  2. Sign in
  3. Click "Reactivate your profile" on the account dashboard
  4. Use screen reader to navigate page contents
  5. Observe that the personal key example includes useful content to describe its purpose as a preview example

👀 Screenshots

Before:

lg-8894-before.mov

After:

lg-8894-after.mov

changelog: User-Facing Improvements, Accessibility, Improve personal key example description for assistive technology
@aduth aduth requested review from a team and nickttng March 10, 2023 13:39
</p>

<div class="scale-down">
<figure class="margin-0 scale-down" aria-label="<%= t('users.personal_key.accessible_labels.preview') %>">
Copy link
Contributor

@jmdembe jmdembe Mar 10, 2023

Choose a reason for hiding this comment

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

Not within the scope of this ticket, but if this were to be made a <figure> element, would it make sense for the personal key partial to be made into a <figcaption> element instead of a typical <div>?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was on the fence about making this change. Visually, it's meant to look like a sort of embedded preview example, and I thought it'd be useful to indicate that somehow rather than just skipping straight to the first bit of content in the preview. I think including a <figcaption> could make sense if the visible preview had some sort of caption. In this implementation, the aria-label serves the purpose captioning the figure, and the personal key partial is the contents of the figure example preview.

Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM, is it worth adding any view specs taht check for aria-hidden or something?

Copy link
Contributor

@nickttng nickttng left a comment

Choose a reason for hiding this comment

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

This improvement looks good to me

@aduth
Copy link
Contributor Author

aduth commented Mar 10, 2023

is it worth adding any view specs taht check for aria-hidden or something?

Yeah 👍 Updated specs in 98e0fc6

@aduth aduth merged this pull request into main Mar 10, 2023
@aduth aduth deleted the aduth-lg-8894-personal-key-example branch March 10, 2023 19:46
mitchellhenke pushed a commit that referenced this pull request Mar 14, 2023
* LG-8894: Describe personal key example for assistive technology

changelog: User-Facing Improvements, Accessibility, Improve personal key example description for assistive technology

* Update personal key specs to test for code example
zachmargolis pushed a commit that referenced this pull request Mar 14, 2023
* LG-8894: Describe personal key example for assistive technology

changelog: User-Facing Improvements, Accessibility, Improve personal key example description for assistive technology

* Update personal key specs to test for code example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants