Components
File upload
Help users select and upload a file. EnhancedField is the improved file upload component: once JavaScript runs, users can choose a file with the button or drop one on it. Without JavaScript it is the native file input.
Read the Design System guidance for file upload
Import
import { FileUpload, FileUploadField } from 'govuk-react/file-upload';Examples
Default
Code
<FileUploadField
id="file-upload"
name="file-upload"
label="Upload a file"
/>Input with hint text
Code
<FileUploadField
id="file-upload"
name="file-upload"
label="Upload a file"
hint="This can be in either JPG or PNG format"
accept=".jpg, .png"
/>Input with hint text error
Code
<FileUploadField
id="file-upload"
name="file-upload"
label="Upload a file"
hint="This can be in either JPG or PNG format"
errorMessage="The CSV must be smaller than 2MB"
/>With error message
Code
<FileUploadField
id="file-upload-1"
name="fileUpload1"
label="Upload a file"
errorMessage="The CSV must be smaller than 2MB"
/>Enhanced
Code
<EnhancedFileUpload.Field {...args} />Enhanced with hint and error
Code
<EnhancedFileUpload.Field {...args} />Enhanced multiple files
Code
<EnhancedFileUpload.Field {...args} />Enhanced disabled
Code
<EnhancedFileUpload.Field {...args} />Enhanced file chosen
A file chosen, for visual regression.
Code
<WithFiles {...args} names={['passport.jpg']} />Enhanced files chosen
Two files chosen, for visual regression.
Code
<WithFiles {...args} names={['passport.jpg', 'driving-licence.png']} />Enhanced dragging
A file dragged over the drop zone, for visual regression.
Code
<WithFiles {...args} names={['passport.jpg']} dragging />With parts
Code
<div className="govuk-form-group">
<label className="govuk-label" id="file-upload-8-label" htmlFor="file-upload-8">
Upload a file
</label>
<EnhancedFileUpload.Root>
<EnhancedFileUpload.Wrapper>
<EnhancedFileUpload.Button>
<EnhancedFileUpload.Status />
<EnhancedFileUpload.Comma />
<EnhancedFileUpload.PseudoButtonContainer>
<EnhancedFileUpload.PseudoButton>Choose photo</EnhancedFileUpload.PseudoButton>{' '}
<EnhancedFileUpload.Instruction>or drop photo</EnhancedFileUpload.Instruction>
</EnhancedFileUpload.PseudoButtonContainer>
</EnhancedFileUpload.Button>
<FileUpload id="file-upload-8" name="fileUpload8" accept="image/*" />
</EnhancedFileUpload.Wrapper>
<EnhancedFileUpload.Announcements />
</EnhancedFileUpload.Root>
</div>API reference
FileUpload
The file input.
| Prop | Type |
|---|---|
error | boolean |
FileUploadField
Help users select and upload a file.
| Prop | Type |
|---|---|
labelThe label used by the file upload component. | ReactNode |
labelSize | "s" | "m" | "l" | "xl" |
labelIsPageHeading | boolean |
hintCan be used to add a hint to the file upload component. | ReactNode |
errorMessageCan be used to add an error message to the file upload component. The error message component will not display if you use a falsy value for | ReactNode |