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 - File input: Evaluate sample label copy #5211

Closed
amyleadem opened this issue Mar 30, 2023 · 4 comments · Fixed by uswds/uswds-site#2213
Closed

USWDS - File input: Evaluate sample label copy #5211

amyleadem opened this issue Mar 30, 2023 · 4 comments · Fixed by uswds/uswds-site#2213
Assignees
Labels
Package: File Input Role: Content Content/writing skills needed

Comments

@amyleadem
Copy link
Contributor

Summary

In the file input component examples, the demo label text should be a helpful example that can be used in the real world. However, the sample label text in our component demos do not provide particularly helpful information about the related input. For example, the default file input example has a label of "Input accepts a single file". We should evaluate if there is an opportunity to improve this text and provide more helpful real-world examples.

Expected behavior

Input label elements should describe the purpose of the related input. Additionally, the label can also provide instructions to the user about how to enter information into the input (example: date format type)

@amyleadem amyleadem changed the title USWDS - File input: Evaluate label copy USWDS - File input: Evaluate sample label copy Mar 30, 2023
@bonnieAcameron bonnieAcameron added the Role: Content Content/writing skills needed label Apr 3, 2023
@amyleadem amyleadem removed their assignment Apr 5, 2023
@bonnieAcameron
Copy link
Contributor

bonnieAcameron commented Apr 6, 2023

After taking a closer look at this, the texts that say "Input accepts a single file," "Input accepts only specific file types," (and other similar directives on the page) are not actually functioning as labels for the related input. They function as sub-headings within the Component Preview section.

Proposed solutions:

  1. Add "about file input" section similar to what we just drafted in In page navigation where we delve a little deeper into the functionality, limitations, and customization possibilities regarding file types.
    2a. Consider changing the styling of what are now inaccurately coded as "label" to something like an h2 so that the user better understands that these labels are not part of the component itself.
    --OR--
    2b. Break out the component previews into separate pieces instead of all in one preview box

I realize this is a bit of a rogue insight @amyleadem , so let's discuss!

@bonnieAcameron
Copy link
Contributor

I'll schedule time with you @amyleadem so we can chat about this.

@bonnieAcameron
Copy link
Contributor

we decided to go with the H2 solution

@bonnieAcameron
Copy link
Contributor

bonnieAcameron commented Sep 27, 2023

Approach has been decided. The work is being completed here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Package: File Input Role: Content Content/writing skills needed
Projects
Archived in project
3 participants