Skip to content

USWDS - Memorable Date: Remove numbers from the dropdown list of months#6028

Merged
thisisdano merged 1 commit into
developfrom
cb-memorable-date-input-options
Oct 3, 2024
Merged

USWDS - Memorable Date: Remove numbers from the dropdown list of months#6028
thisisdano merged 1 commit into
developfrom
cb-memorable-date-input-options

Conversation

@cathybaptista

@cathybaptista cathybaptista commented Aug 19, 2024

Copy link
Copy Markdown
Contributor

Summary

Removed the leading numbers from the month options in the memorable date component. Recent usability testing indicated that having both numbers and names to represent months was confusing for screen reader users.

Breaking change

This is not a breaking change.

Related issue

Closes #5910

Related pull requests

Changelog uswds/uswds-site#2787

Preview link

Preview link: Memorable Date preview

Problem statement

The desired state for the memorable date component is that there is only one option for the values in the months dropdown (either numbers or month names) so that users can search by typing in the month name. The current state is that both the number and the month name are included in the option dropdown, which means users cannot search by the month name.

Solution

The solution is to remove the numbers from the memorable date component option dropdown. Another approach was to make both options (numbers AND month names) available, but the risk of this approach did not outweigh the rewards. The team decided that including month names is the best way to resolve this accessibility issue.

Testing and review

  1. Opened federalist link and inspected source.
  2. Verify that the id="date_of_birth_month" options do not include a number.
  3. Opened the component in production.
  4. Verify that the id="date_of_birth_month" options includes a number.
  5. Verify that if you tab to the memorable date month field and hit the first letter of each month on the keyboard the correct month appears.
  6. Verify that the correct code appears on uswds-site for this component when the "component code" button is selected. This code should not include numbers.

@mejiaj mejiaj 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.

Confirming I can navigate using keyboard more easily. Thanks Cathy!

uswds-memorable-date-6028.webm

@mahoneycm mahoneycm 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.

Searching by name is working for me! I think this will clear up a lot of the confusion.

Thanks @cathybaptista !

@amyleadem amyleadem 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.

Thanks for making this update @cathybaptista. The code update looks good!

Quick request before approval: Can you update the summary in the PR description to be a bit more succinct? We try to pull that PR summary into the release notes and the current one is a bit too long to be useful in that context. If desired, we can move the additional information that is currently in the "summary" section down to the "solution" section.

I'm thinking something like this should work (Feel free to edit):

Removed the leading numbers from the month options in the memorable date component. Recent usability testing indicated that having both numbers and names to represent months was confusing for screen reader users.

@amyleadem

Copy link
Copy Markdown
Contributor

Oh, one more thought: I believe we wouldn't mark this as a breaking change in the description, since nothing will technically break if the user doesn't change anything. Instead, we mark this as just a markup change. See the release notes for examples of other non-breaking markup changes.

@mejiaj

mejiaj commented Aug 28, 2024

Copy link
Copy Markdown
Contributor

Moving the original issue back to In progress to capture requested changes @amyleadem mentioned.

@amyleadem amyleadem 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.

Looks good to me! Thanks @cathybaptista

Moved the issue to FFR

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.

USWDS - Memorable date: Input options don't meet some users expectations

5 participants