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

USWDS-Site - Guidance: Update usability guidance for Date Picker and Date Range Picker #2822

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

cathybaptista
Copy link
Contributor

@cathybaptista cathybaptista commented Sep 11, 2024

Summary

Date Picker and Date Range Picker should always allow users to type the date manually if that is preferred.
Add text to the Usability Guidance sections for both components to let users know they should account for this preference.

Related issue

Closes #2294

Preview links

Preview links:

Date Picker

Date Range Picker

Changelog links:

Date Picker

Date Range Picker

Problem statement

Not all users want to use the calendar picker for dates. The Date Picker and the Date Range Picker components should be implemented so that users can enter dates manually if they choose to do so.

Solution

Update the guidance for Date Picker and Date Range Picker so that users are aware that these components should be implemented to allow users to type dates in manually.

Major changes

N/A, this is a change to the usability guidance.

Testing and review

  1. Click on each supplied federalist link.
  2. Ensure that this text appears in "usability guidance" after any previous supplied guidance:

Always allow a user to type in the date manually. Usability testing suggests some people prefer manually typing the date rather than using the calendar picker. Whenever possible, keep the keyboard active so people can enter in the date information without having to use the picker.

Before opening this PR, make sure you’ve done whichever of these applies to you:

  • Confirm that this code follows the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run git pull origin [base branch] to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch is main).
  • Run npm run prettier:scss to format any Sass updates.
  • Run npm test and confirm that all tests pass.
  • Run your code through HTML_CodeSniffer and make sure it’s error free.

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Changes look good! Requested a couple small formatting changes below. Also, can you create changelog entries for these changes? After that, we should be good!

_components/date-picker/guidance/usability.md Outdated Show resolved Hide resolved
_components/date-range-picker/guidance/usability.md Outdated Show resolved Hide resolved
Copy link
Contributor

@finekatie finekatie left a comment

Choose a reason for hiding this comment

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

I approve the new date picker language for Usability guidance section for both components

Merge branch 'cb-changelog-2822' into cb-date-picker-and-date-range-guidance
Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looks good @cathybaptista. Added a couple of minor suggestions for the changelogs below.

_data/changelogs/component-date-picker.yml Outdated Show resolved Hide resolved
_data/changelogs/component-date-picker.yml Outdated Show resolved Hide resolved
_data/changelogs/component-date-range-picker.yml Outdated Show resolved Hide resolved
_data/changelogs/component-date-range-picker.yml Outdated Show resolved Hide resolved
@@ -2,6 +2,13 @@ title: Date picker
type: component
changelogURL:
items:
- date: NNNN-NN-NN
Copy link
Contributor

Choose a reason for hiding this comment

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

Important

We should update the changelog dates before merge

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi, @amyleadem, do I just leave this here or do something else? Just let me know. :)

Copy link
Contributor

Choose a reason for hiding this comment

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

No action needed from you now. Just flagging that this needs to be updated by whoever merges the PR (Usually Dan)

Copy link
Contributor

@annepetersen annepetersen Sep 17, 2024

Choose a reason for hiding this comment

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

For usability guidance that's primarily content, I should be able to merge also. Just did updated the changelog dates, and intend to merge once checks are completed successfully.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could someone double-check on these failing/errored checks?

Copy link
Contributor

Choose a reason for hiding this comment

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

@amyleadem or @cathybaptista, what should I know, and/or could you confirm whether or not I should merge despite these fails/errors?

Merge remote-tracking branch 'origin' into cb-date-picker-and-date-range-guidance
Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @cathybaptista

updated changelog date
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-Site - Date Picker/Date Range Picker Guidance: Allow for manual entry
5 participants