Ask users for…

Files

Also known as: File upload

Usage

When to use this pattern

• Required documentation. When a user must upload a file in order to provide required documentation.

When not to use this pattern

• Don’t ask for a file if does not affect the delivery of a service. You should only ask users to upload documents if absolutely necessary.

Examples

Default

Review

Delete

How to design and build

Layout details

Use the File input component along with the following content placed above it:

• Header that clearly describes what file to upload
• Instructions explaining what file(s) to upload and why they’re needed
• Bullet list of allowed file types and maximum file sizes

Important: Avoid allowing batch file uploads. Batch uploads are not mobile-friendly and can create user experience and technical issues. Instead, use multiple individual file input components when you need users to upload several files.

How this pattern works

We’ve updated the File input component to encapsulate this pattern. Upgrade to the latest file input component to get the current functionality.

• List allowed file types and sizes above the File input component. This helps prevent errors. Most VA forms accept PDF, JPG, JPEG, and PNG files.
• Provide clear instructions. Tell users exactly what document to upload and why it’s needed for their application.
• Validate file uploads and provide clear error messages. Review feedback messages in the Messages dictionary for file upload success and error messages.

Code usage

Forms library validation

The forms-system validates every file before upload for:

• Mime-type and file extension match (e.g., prevents my-pdf.png)
• UTF encoding to ensure proper file handling
• PDF encryption - The forms library detects if a PDF is encrypted and, if so, prompts the user for a password. The password is required to send the file to the backend for decryption before form submission.

Note: If validation fails, an error message is sent to the component and displayed to the user.

File submission

The pattern handles the submission to the endpoint and returns a response if there is an error.

Content considerations

• Use explicit and specific words for actions. We prefer “upload” and “delete” as those words describe exactly what will happen when you tap or click.
  • Upload instead of add. Use the word “Upload” instead of “Add”. For example, “Upload file” and “Upload another file”.
  • Delete instead of remove. Use the word “Delete” instead of “Remove”. For example, “Delete file”. Also, do not use “Edit” unless the uploaded file can actually be edited in place. “Edit” is not appropriate for an uploaded file if the user has to delete and re-upload the file.
• Use file instead of document. File is the broadest term and thus preferable to “document” as that may be too specific when images, text files, and other file types may be acceptable for upload.

• Follow messaging guidance. Follow the feedback messages in the messages dictionary for file upload success and failure.

• Consider the mobile experience. Avoid using words like “scan” or “convert” in the file upload instructions.

If your team needs help customizing the content of the component to address upload problems and user errors, contact the Content and IA centralized team for support.

Accessibility considerations

• Do not italicize file type and size help text. Long strings of italicized text can be difficult to read for some users with low vision or reading disabilities.
• Ask for confirmation when deleting files. Destructive actions like deleting files should require two steps by users — the initial button click, and then a confirmation. This helps prevent users from accidentally deleting a file with an unintentional click, and provides an extra prompt for screen reader users and screen magnification users who might not see the visual change when a file is removed.
• Provide clear error messages. When file uploads fail, ensure error messages clearly explain what went wrong and how to fix the issue.