File uploader
<gcds-file-uploader>
Also called: file upload, file input, dropzone.
A file uploader is a space to select and add supporting documentation.
-
GitHub -
Figma
File uploader component preview
Build a file uploader
Use the file uploader to allow a person to select and review files they’d like to include with their submission.
Code and accessibility for file uploader
Apply required attributes
For the file uploader to function properly, always use the following attributes with <gcds-file-uploader>
:
name
label
uploader-id
Handle error messages and validation
-
Use the
required
attribute to activate the required validator. Validation will happen by default on theonBlur
event. A missing or invalid entry will prompt an inline error message with preset text. -
If you need to change the validation event, use the
validate-on
attribute. Validation can happen on blur, when the element loses focus, or manually with thevalidate()
method. -
Use the
required
attribute for fields that must be filled in. This places "required" at the end of the label. -
Use the
error-message
attribute to include an error message text for all required inputs. Avoid using error messages for optional ones. -
For optional fields, avoid adding the
error-message
attribute. -
For an optional field that needs validation based on user input (like validating an email address format), opt to add custom validation with a custom error message.
Upload multiple files
Allow the selection of more than one file using the multiple
attribute.
Validate file types for upload
Define the file types the file uploader accepts using the accept
attribute.
Get your code
Generate an instance of the component you need by selecting its code properties.
-
Explore by choosing different code values to generate the instance you want.
-
Get the code and pull it into your environment.
-
Add any copy you need to the component (like text for a label).
Note: The code builder uses English for all code elements, which follows standard practice.
Help us improve
Have questions or a request? Give feedback on our contact form.
Something's wrong? Raise it through GitHub with an