Skip to content

LG-9816: Add accepted special characters to hint text on ID number page#8435

Merged
gina-yamada merged 12 commits intomainfrom
gina/lg-9816-ID-number-help-text
May 25, 2023
Merged

LG-9816: Add accepted special characters to hint text on ID number page#8435
gina-yamada merged 12 commits intomainfrom
gina/lg-9816-ID-number-help-text

Conversation

@gina-yamada
Copy link
Copy Markdown
Contributor

@gina-yamada gina-yamada commented May 18, 2023

🎫 Ticket

LG-9816 Implementation: Add accepted special characters to hint text on ID number page

🛠 Summary of changes

  • Updated ID number hint text
  • Increased the input width of ID number
  • Use class usa-sr-only with English/Spanish/French translation (spaces, forward slashes, asterisks, and dashes) because VoiceOver on Mac did not read spaces and dashes, read star for asterisk, and read slash for forward slash

📜 Testing Plan

Create an account. Attempt to verify your identity via /verify.
Upload front/back of ID to fail identity verification. Click Try in person and Continue.
Get to view Enter the information on your ID. Confirm ID number hint text has been updated from "May include letters and numbers" to "May include letters, numbers, and the following symbols: / * - "

  • Confirm update in English /verify/in_person/state_id
  • Confirm update in Spanish /es/verify/in_person/state_id
  • Confirm update in French /fr/verify/in_person/state_id
  • Confirm input field for ID number has increased in size and is the same size as other input fields on the form (First name, for example)
  • Confirm responsiveness for ID number input is working as expected

👀 Screenshots

Before:

Screenshot 2023-05-18 at 3 22 09 PM

After:

See screenshots below in conversation. The text now breaks so that the characters are not hanging out on a line with no other text when the screen size is 640px or larger.

Screenshot 2023-05-18 at 2 56 44 PM

Screenshot 2023-05-18 at 2 52 25 PM

Screenshot 2023-05-18 at 11 10 40 AM

Responsive Samples After:

See screenshots below in conversation. The text now breaks so that the characters are not hanging out on a line with no other text when the screen size is 640px or larger.

Screenshot 2023-05-18 at 3 00 32 PM

Screenshot 2023-05-18 at 3 00 01 PM

Screenshot 2023-05-18 at 2 59 47 PM

@gina-yamada gina-yamada requested a review from allis-green May 18, 2023 21:27
@gina-yamada
Copy link
Copy Markdown
Contributor Author

gina-yamada commented May 18, 2023

@allis-green I have two questions.

  1. I increased the ID number input. It was not a task in the issue. The mocks do display a wider input. I think it looks better with the increased size now that the hint text is longer. Please confirm that is okay.

  2. The French translation flows on the next line. I kept the spacing consistent but snapped a few photos of some alternative options. Right now there is a space between each character (exactly as it appears in the issue). Let me know if you'd like to see something different. If you pick something different, do you want me to keep the spacing consistent across all translations? (I bet yes but confirm.) More details (screenshots of options) are in the issue.

@gina-yamada gina-yamada reopened this May 19, 2023
@gina-yamada gina-yamada requested a review from JackRyan1989 May 19, 2023 14:54
Copy link
Copy Markdown
Contributor

@JackRyan1989 JackRyan1989 left a comment

Choose a reason for hiding this comment

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

LGTM!

@JackRyan1989
Copy link
Copy Markdown
Contributor

This looks good to me. One weird thing I noticed when testing with a screen reader though, the '-' is not read using VoiceOver. Looks like this is known behavior: https://www.deque.com/blog/dont-screen-readers-read-whats-screen-part-1-punctuation-typographic-symbols/

One thing you could try is using &ndash (you would have to escape it in the yml file I think), or just putting a space behind the '-' before the final quote in the translation files.

@gina-yamada gina-yamada requested review from a team and WheresHJ May 22, 2023 18:10
@gina-yamada
Copy link
Copy Markdown
Contributor Author

@WheresHJ Standard break point is for tablet at min-width 640px. Any screen size 640 and greater will display text on the second line. See conversation above. Here are a few screenshots for you 👇. If it looks good, can you approve this PR? Thank you Harlan

Screenshot 2023-05-23 at 9 02 28 AM Screenshot 2023-05-23 at 9 02 39 AM Screenshot 2023-05-23 at 9 02 57 AM

@gina-yamada
Copy link
Copy Markdown
Contributor Author

gina-yamada commented May 23, 2023

@JackRyan1989

I wanted to respond back to your comment about the screen reader and the '-'. I first attempted modifying the yml file with no luck. After more research I learned the work arounds are can be more confusing for most (and for our purpose, not helpful).

This article has a list of 2023 safe and unread characters. All forms of dash are not supported consistently. The alternative is to include the word in the hint text itself rather than the symbol. Also, space is okay but not read. Thinking about it too.

Maybe the text should be updated from:
"May include letters, numbers, and the following symbols: / * - " ...to...
"May include letters, numbers, spaces, dashes, and the following symbols: / * "

@WheresHJ What are your thoughts?

Extra info:
My screen reader translates the following characters to....

symbol screen reader what I expected
/ slash forward slash
* star astrick

@aduth
Copy link
Copy Markdown
Contributor

aduth commented May 23, 2023

Maybe we can use screen-reader-only text to read out a full text description of the symbol as an alternative to the visual symbol?

e.g.

May include letters, numbers, and the following symbols: <span class="usa-sr-only">forward slash,</span><span aria-hidden="true">/</span> <span class="usa-sr-only">asterisk,</span><span aria-hidden="true">*</span> <span class"usa-sr-only">dash</span><span aria-hidden="true">-</span>

@gina-yamada
Copy link
Copy Markdown
Contributor Author

gina-yamada commented May 23, 2023

Update: I will be using @aduth 's solution above. The screen reader will read the text rather than attempt to interpret the symbol which is proving problematic for all characters/symbols in some sort. (Space is ignored, / is slash and not forward slash, * is star and not asterisks, and - is also ignored.)

Screenshot 2023-05-23 at 3 50 33 PM

This PR is still in draft. I will update when I get translations. (I made request in issue.)

Copy link
Copy Markdown

@WheresHJ WheresHJ left a comment

Choose a reason for hiding this comment

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

LGTM! @JackRyan1989, I'm assuming your tag for me was resolved by using @aduth's solution; if not, lemme know!

@gina-yamada gina-yamada marked this pull request as ready for review May 24, 2023 21:33
@gina-yamada gina-yamada requested a review from JackRyan1989 May 24, 2023 21:50
@gina-yamada
Copy link
Copy Markdown
Contributor Author

@JackRyan1989 @aduth Translations came in! Files have been updated. Please have another review and approve if you think this is ready. Thanks for everyones input/suggestions here.

Copy link
Copy Markdown
Contributor

@JackRyan1989 JackRyan1989 left a comment

Choose a reason for hiding this comment

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

Overall this looks good to me! Great job!

state_id_jurisdiction_prompt: '- Select -'
state_id_number: ID number
state_id_number_hint: May include letters and numbers
state_id_number_hint_html: "May include letters, numbers, and the following
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.

Looking at this again, it looks, not great. But since the classes used are not for styling per se, and thus not super likely to change anytime soon, I think this is ok.

Copy link
Copy Markdown
Contributor

@aduth aduth left a comment

Choose a reason for hiding this comment

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

LGTM! Tested to confirm this appears visually with the symbols and announces the text description for screen reader:

Screen Shot 2023-05-25 at 9 22 45 AM

Screen Shot 2023-05-25 at 9 22 33 AM

@gina-yamada gina-yamada merged commit b4b2fa7 into main May 25, 2023
@gina-yamada gina-yamada deleted the gina/lg-9816-ID-number-help-text branch May 25, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants