department-of-veterans-affairs / vets-design-system-documentation

Repository for design.va.gov website
https://design.va.gov
36 stars 55 forks source link

DST Staging Review (Consider): Design System guidance may mislead VFS teams #2834

Closed shiragoodman closed 1 week ago

shiragoodman commented 2 weeks ago

Need help? Please review how to read a Staging Review ticket. Tag @platform-governance-team-members on Slack if you need further assistance.

Design System Staging Information

Component: Button Icon Staging Review ticket: Staging Review: Design System Button Icon Component

Findings details

The details of this ticket are for consideration only. No Staging Review issue was found. High-priority: No Collab Cycle Reviewer: @briandeconinck (Accessibility)

Description

As currently coded, the component only has three valid values for the button-type prop, and that prop determines what the button label will be. Since content is so constrained, does it make sense for the Content Considerations section on the Design System website to be providing guidance? That section implies that content is within a VFS team's control, when it's not. Other constrained components explicitly call out those limitations, eg. the Crisis Line Modal.

Recommended action

If there's still value in having the Content Considerations guidance, maybe include some explanation in that section that there are only 3 supported states, and that this is the reasoning behind the label text for those states. As currently presented, it's easy to imagine a designer believing they can write their own text following these content guidelines --- only for their engineer to tell them nope, not supported.

References


Next Steps for DST

humancompanion-usds commented 1 week ago

Updated guidance to make this more clear:

Requesting new instances

The 3 examples above are the only currently approved instances of this component. Use of icons in buttons of any type will be made on a case-by-case basis. If you feel you need an icon for a button, follow the process for requesting a new icon and indicate that you would like to use it in Button - Icon or another button type.