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

Request for documentation for a pattern and guidance for links/buttons that are document downloads, i.e. PDF #2451

Open
danbivins opened this issue Apr 6, 2023 · 1 comment
Labels
Impacts: Documentation Indicates that this item relates to documentation Status: In JIRA Indicates that this item is also tracked in Jira

Comments

@danbivins
Copy link
Collaborator

Description
Currently there isn't clear guidance around how to let a user know that they are about to download a PDF and if that may be a large download. I asked around the teams and this is being handled in various ways — different text, some use an icon and some not, etc.

This could benefit users with slower internet connections, older devices, etc.

This pattern guidance could look like:

  • Download your file, PDF {icon}
  • Download your file (PDF), 10MB
@danbivins danbivins added the Impacts: Documentation Indicates that this item relates to documentation label Apr 6, 2023
@Karak888 Karak888 added the Status: In JIRA Indicates that this item is also tracked in Jira label Apr 12, 2023
@danbivins
Copy link
Collaborator Author

Note, from USWDS guidance:

Show file type and size for links to non-HTML content. When possible, create HTML pages instead of linking to files like PDFs. If you do link to a file, tell users ahead of time if the link may trigger a file download, and show the size and format of that file.

We recommend including this information at the end of the link, in the format [FILE_TYPE, SIZE]. We recommend using the file type rather than a product name. Use uppercase for the file type and a comma for the separator. For file size, use the number of pages in the document or the size in MB or KB if the document is not paginated.

Example 1:

GSA published a report, Transforming the American Digital Experience [PDF, 18 pages]

Example 2:

Download the Revised 508 Standards Applicability Checklist [DOCX, 2 pages]

Example 3:

Download the USWDS 2.11.2 Design Kit for Sketch [ZIP, 13.3 MB]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Impacts: Documentation Indicates that this item relates to documentation Status: In JIRA Indicates that this item is also tracked in Jira
Projects
None yet
Development

No branches or pull requests

2 participants