department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 204 forks source link

[Content styleguide] Labels or instructions aren't provided when content requires user input. (05.11.1) #29359

Closed shiragoodman closed 3 years ago

shiragoodman commented 3 years ago

General Information

VFS team name

Education Application (BAH)

VFS product name

Comparison Tool Redesign

Point of Contact/Reviewers

Trevor Pierce (Accessibility) Peggy Gannon (Content)


Platform Issue

Labels or instructions aren't provided when content requires user input.

Issue Details

Search by location tab: The city, state, postal code input must have a label

Seach by name tab: School, employer, or training provider doesn't have a label

Link, screenshot or steps to recreate

Screen Shot 2021-08-26 at 5 22 19 PM


Screen Shot 2021-08-26 at 5 22 24 PM

VA.gov Experience Standard

Cateogy Number 05, Issue Number 11

Other References

WCAG SC 3.3.2_A


Platform Recommendation

Add a visual label (ideal) or an aria-label to the input

Acceptance Criteria:

  1. For search by name: a. There is no helper text within the search field input. b. The search field input has the following label: School, employer, or training provider. c. The input is a required field. d. The following validation message is displayed when trying to execute a search without entering information: Please fill in a school, employer, or training provider.

  2. For search by location: a. There is no helper text within the search field input. b. The search field input has the following label: City, state, or postal code. c. The input is a required field. d. The following validation message is displayed when trying to execute a search without entering information: Please fill in a city, state, or postal code.

Supporting Artifacts:

  1. Desktop prototype
  2. Mobile prototype

VFS Team Tasks to Complete

amyknox commented 3 years ago

@dneel-bah

Desktop prototype here Mobile prototype here

Fix: Remove text from inside the text field and add a label above the text field. Per Monday's discussion, we added (*Required) to these fields so an error message will display if a user attempts to search with an empty field.

ERROR MESSAGES Name search error message: Please fill in a school, employer, or training provider. Location search error: Please fill in a city, state, or postal code.

devin-mccurdy commented 3 years ago

PR: https://github.com/department-of-veterans-affairs/vets-website/pull/18522

mattpointzxer0 commented 3 years ago

Lookin' good!