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

Download link guidance update - documentation #3579

Closed
5 tasks
caw310 opened this issue Dec 5, 2024 · 5 comments
Closed
5 tasks

Download link guidance update - documentation #3579

caw310 opened this issue Dec 5, 2024 · 5 comments
Assignees
Labels
documentation-design.va.gov Updates to documentation on design.va.gov platform-design-system-team va-action-link DS Action Link component va-link DS Link

Comments

@caw310
Copy link
Contributor

caw310 commented Dec 5, 2024

Description

During DSC meeting discussing this experimental design request, it came up that documenation on download link needs updating. Look into the behavior of the download link and add guidance on the behavior.

Details

Tasks

  • Review how download link works and review documentation
  • Update guidance to reflect how download link should behave
  • Have DST designer review
  • Publish update

Acceptance Criteria

  • Guidance on download link behavior has been updated,
@caw310 caw310 added documentation-design.va.gov Updates to documentation on design.va.gov platform-design-system-team va-action-link DS Action Link component va-link DS Link labels Dec 5, 2024
@babsdenney
Copy link
Contributor

We discussed this and determined that we need to verify if this download link should be a link or a button and this should go through an accessibility review first. Depending on if it is a link or button will dictate the design.

See the design chat notes for more information

@caw310
Copy link
Contributor Author

caw310 commented Jan 16, 2025

@rsmithadhoc reassigning to you now.

@rsmithadhoc
Copy link
Contributor

rsmithadhoc commented Jan 27, 2025

I updated the docs in this PR. A download should use a link because it's a navigational action to access that separate file.

W3C also provides a download attribute for links, but not buttons. So I think that also suggests links should be used for downloads.

  • However, I don't believe we need to add that to the component at this time. When testing this, I didn't see any difference in behavior or how screen readers announced the link.

@danbrady
Copy link
Contributor

From a general experience standpoint, if it's a "download" link, then I'm thinking it should prompt the user with the browser download dialog (by using that download attribute). (Or at least have a prop to toggle this attribute.)

Thoughts, @humancompanion-usds?

@rsmithadhoc
Copy link
Contributor

We can definitely add it, but I didn't see any difference with that attribute. I'll close this one out, but can open another ticket if we decide to add that to the component. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-design.va.gov Updates to documentation on design.va.gov platform-design-system-team va-action-link DS Action Link component va-link DS Link
Projects
None yet
Development

No branches or pull requests

5 participants