File upload
Help users select and upload a file.
<div id="file-upload-1" class="govuk-form-group">
<label
for="file-upload-1-input"
class="govuk-label"
>
Upload a file
</label>
<input
name="file-upload-1"
id="file-upload-1-input"
class="govuk-file-upload"
type="file"
/>
</div>
<FileUpload
id="file-upload-1"
name="file-upload-1"
label="Upload a file"
/>
Props
Name | Type | Default | Description |
---|---|---|---|
title | string | ||
id | string | 'id' attribute to place on the base HTML element | |
classBlock | string | Block name override in BEM style classes applied to all elements | |
classModifiers | other | BEM style modifiers to apply to the base HTML element | |
className | string | Extra classes to apply to the base HTML element | |
form | string | ||
list | string | ||
defaultChecked | boolean | ||
defaultValue | other | ||
suppressContentEditableWarning | boolean | ||
suppressHydrationWarning | boolean | ||
accessKey | string | ||
autoFocus | boolean | ||
contentEditable | other | ||
contextMenu | string | ||
dir | string | ||
draggable | other | ||
enterKeyHint | enum | ||
hidden | boolean | ||
lang | string | ||
nonce | string | ||
slot | string | ||
spellCheck | other | ||
style | other | ||
tabIndex | number | ||
translate | enum | ||
radioGroup | string | ||
role | other | ||
about | string | ||
content | string | ||
datatype | string | ||
inlist | other | ||
prefix | string | Prefix to show before the field | |
property | string | ||
rel | string | ||
resource | string | ||
rev | string | ||
typeof | string | ||
vocab | string | ||
autoCapitalize | string | ||
autoCorrect | string | ||
autoSave | string | ||
color | string | ||
itemProp | string | ||
itemScope | boolean | ||
itemType | string | ||
itemID | string | ||
itemRef | string | ||
results | number | ||
security | string | ||
unselectable | enum | ||
inputMode | enum | Hints at the type of data that might be entered by the user while editing the element or its contents | |
is | string | Specify that a standard HTML element should behave like a defined custom built-in element | |
aria-activedescendant | string | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. | |
aria-atomic | other | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. | |
aria-autocomplete | enum | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. | |
aria-braillelabel | string | Defines a string value that labels the current element, which is intended to be converted into Braille. | |
aria-brailleroledescription | string | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. | |
aria-busy | other | ||
aria-checked | other | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. | |
aria-colcount | number | Defines the total number of columns in a table, grid, or treegrid. | |
aria-colindex | number | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. | |
aria-colindextext | string | Defines a human readable text alternative of aria-colindex. | |
aria-colspan | number | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. | |
aria-controls | string | Identifies the element (or elements) whose contents or presence are controlled by the current element. | |
aria-current | other | Indicates the element that represents the current item within a container or set of related elements. | |
aria-describedby | string | Identifies the element (or elements) that describes the object. | |
aria-description | string | Defines a string value that describes or annotates the current element. | |
aria-details | string | Identifies the element that provides a detailed, extended description for the object. | |
aria-disabled | other | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. | |
aria-dropeffect | enum | Indicates what functions can be performed when a dragged object is released on the drop target. | |
aria-errormessage | string | Identifies the element that provides an error message for the object. | |
aria-expanded | other | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | |
aria-flowto | string | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. | |
aria-grabbed | other | Indicates an element's "grabbed" state in a drag-and-drop operation. | |
aria-haspopup | other | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | |
aria-hidden | other | Indicates whether the element is exposed to an accessibility API. | |
aria-invalid | other | Indicates the entered value does not conform to the format expected by the application. | |
aria-keyshortcuts | string | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. | |
aria-label | string | Defines a string value that labels the current element. | |
aria-labelledby | string | Identifies the element (or elements) that labels the current element. | |
aria-level | number | Defines the hierarchical level of an element within a structure. | |
aria-live | enum | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. | |
aria-modal | other | Indicates whether an element is modal when displayed. | |
aria-multiline | other | Indicates whether a text box accepts multiple lines of input or only a single line. | |
aria-multiselectable | other | Indicates that the user may select more than one item from the current selectable descendants. | |
aria-orientation | enum | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. | |
aria-owns | string | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. | |
aria-placeholder | string | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. | |
aria-posinset | number | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | |
aria-pressed | other | Indicates the current "pressed" state of toggle buttons. | |
aria-readonly | other | Indicates that the element is not editable, but is otherwise operable. | |
aria-relevant | enum | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. | |
aria-required | other | Indicates that user input is required on the element before a form may be submitted. | |
aria-roledescription | string | Defines a human-readable, author-localized description for the role of an element. | |
aria-rowcount | number | Defines the total number of rows in a table, grid, or treegrid. | |
aria-rowindex | number | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. | |
aria-rowindextext | string | Defines a human readable text alternative of aria-rowindex. | |
aria-rowspan | number | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. | |
aria-selected | other | Indicates the current "selected" state of various widgets. | |
aria-setsize | number | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. | |
aria-sort | enum | Indicates if items in a table or grid are sorted in ascending or descending order. | |
aria-valuemax | number | Defines the maximum allowed value for a range widget. | |
aria-valuemin | number | Defines the minimum allowed value for a range widget. | |
aria-valuenow | number | Defines the current value for a range widget. | |
aria-valuetext | string | Defines the human readable text alternative of aria-valuenow for a range widget. | |
dangerouslySetInnerHTML | other | ||
onCopy | other | ||
onCopyCapture | other | ||
onCut | other | ||
onCutCapture | other | ||
onPaste | other | ||
onPasteCapture | other | ||
onCompositionEnd | other | ||
onCompositionEndCapture | other | ||
onCompositionStart | other | ||
onCompositionStartCapture | other | ||
onCompositionUpdate | other | ||
onCompositionUpdateCapture | other | ||
onFocus | other | ||
onFocusCapture | other | ||
onBlur | other | ||
onBlurCapture | other | ||
onChange | other | ||
onChangeCapture | other | ||
onBeforeInput | other | ||
onBeforeInputCapture | other | ||
onInput | other | ||
onInputCapture | other | ||
onReset | other | ||
onResetCapture | other | ||
onSubmit | other | ||
onSubmitCapture | other | ||
onInvalid | other | ||
onInvalidCapture | other | ||
onLoad | other | ||
onLoadCapture | other | ||
onError | other | ||
onErrorCapture | other | ||
onKeyDown | other | ||
onKeyDownCapture | other | ||
onKeyPress | other | ||
onKeyPressCapture | other | ||
onKeyUp | other | ||
onKeyUpCapture | other | ||
onAbort | other | ||
onAbortCapture | other | ||
onCanPlay | other | ||
onCanPlayCapture | other | ||
onCanPlayThrough | other | ||
onCanPlayThroughCapture | other | ||
onDurationChange | other | ||
onDurationChangeCapture | other | ||
onEmptied | other | ||
onEmptiedCapture | other | ||
onEncrypted | other | ||
onEncryptedCapture | other | ||
onEnded | other | ||
onEndedCapture | other | ||
onLoadedData | other | ||
onLoadedDataCapture | other | ||
onLoadedMetadata | other | ||
onLoadedMetadataCapture | other | ||
onLoadStart | other | ||
onLoadStartCapture | other | ||
onPause | other | ||
onPauseCapture | other | ||
onPlay | other | ||
onPlayCapture | other | ||
onPlaying | other | ||
onPlayingCapture | other | ||
onProgress | other | ||
onProgressCapture | other | ||
onRateChange | other | ||
onRateChangeCapture | other | ||
onResize | other | ||
onResizeCapture | other | ||
onSeeked | other | ||
onSeekedCapture | other | ||
onSeeking | other | ||
onSeekingCapture | other | ||
onStalled | other | ||
onStalledCapture | other | ||
onSuspend | other | ||
onSuspendCapture | other | ||
onTimeUpdate | other | ||
onTimeUpdateCapture | other | ||
onVolumeChange | other | ||
onVolumeChangeCapture | other | ||
onWaiting | other | ||
onWaitingCapture | other | ||
onAuxClick | other | ||
onAuxClickCapture | other | ||
onClick | other | ||
onClickCapture | other | ||
onContextMenu | other | ||
onContextMenuCapture | other | ||
onDoubleClick | other | ||
onDoubleClickCapture | other | ||
onDrag | other | ||
onDragCapture | other | ||
onDragEnd | other | ||
onDragEndCapture | other | ||
onDragEnter | other | ||
onDragEnterCapture | other | ||
onDragExit | other | ||
onDragExitCapture | other | ||
onDragLeave | other | ||
onDragLeaveCapture | other | ||
onDragOver | other | ||
onDragOverCapture | other | ||
onDragStart | other | ||
onDragStartCapture | other | ||
onDrop | other | ||
onDropCapture | other | ||
onMouseDown | other | ||
onMouseDownCapture | other | ||
onMouseEnter | other | ||
onMouseLeave | other | ||
onMouseMove | other | ||
onMouseMoveCapture | other | ||
onMouseOut | other | ||
onMouseOutCapture | other | ||
onMouseOver | other | ||
onMouseOverCapture | other | ||
onMouseUp | other | ||
onMouseUpCapture | other | ||
onSelect | other | ||
onSelectCapture | other | ||
onTouchCancel | other | ||
onTouchCancelCapture | other | ||
onTouchEnd | other | ||
onTouchEndCapture | other | ||
onTouchMove | other | ||
onTouchMoveCapture | other | ||
onTouchStart | other | ||
onTouchStartCapture | other | ||
onPointerDown | other | ||
onPointerDownCapture | other | ||
onPointerMove | other | ||
onPointerMoveCapture | other | ||
onPointerUp | other | ||
onPointerUpCapture | other | ||
onPointerCancel | other | ||
onPointerCancelCapture | other | ||
onPointerEnter | other | ||
onPointerLeave | other | ||
onPointerOver | other | ||
onPointerOverCapture | other | ||
onPointerOut | other | ||
onPointerOutCapture | other | ||
onGotPointerCapture | other | ||
onGotPointerCaptureCapture | other | ||
onLostPointerCapture | other | ||
onLostPointerCaptureCapture | other | ||
onScroll | other | ||
onScrollCapture | other | ||
onWheel | other | ||
onWheelCapture | other | ||
onAnimationStart | other | ||
onAnimationStartCapture | other | ||
onAnimationEnd | other | ||
onAnimationEndCapture | other | ||
onAnimationIteration | other | ||
onAnimationIterationCapture | other | ||
onTransitionEnd | other | ||
onTransitionEndCapture | other | ||
step | other | ||
disabled | boolean | ||
formAction | string | ||
formEncType | string | ||
formMethod | string | ||
formNoValidate | boolean | ||
formTarget | string | ||
name | string | ||
value | other | ||
accept | string | ||
alt | string | ||
autoComplete | other | ||
capture | other | ||
checked | boolean | ||
height | other | ||
max | other | ||
maxLength | number | ||
min | other | ||
minLength | number | ||
multiple | boolean | ||
pattern | string | ||
placeholder | string | ||
readOnly | boolean | ||
required | boolean | ||
size | number | ||
src | string | ||
width | number | Width of the field in characters (approximate) | |
suffix | string | Suffix to show after the field | |
error | other | Error message | |
hint | other | Hint | |
label | other | Label |
When to use this component
You should only ask users to upload something if it’s critical to the delivery of your service.
How it works
<div id="file-upload-1" class="govuk-form-group">
<label
for="file-upload-1-input"
class="govuk-label"
>
Upload a file
</label>
<input
name="file-upload-1"
id="file-upload-1-input"
class="govuk-file-upload"
type="file"
/>
</div>
<FileUpload
id="file-upload-1"
name="file-upload-1"
label="Upload a file"
/>
Error messages
Error messages should be styled like this:
<div
id="file-upload-1"
class="govuk-form-group govuk-form-group--error"
>
<label
for="file-upload-1-input"
class="govuk-label"
>
Upload a file
</label>
<p
id="file-upload-1-error"
class="govuk-error-message"
>
<span class="govuk-visually-hidden">Error:</span>
The CSV must be smaller than 2MB
</p>
<input
name="file-upload-1"
aria-describedby="file-upload-1-error"
id="file-upload-1-input"
class="govuk-file-upload govuk-file-upload--error"
type="file"
/>
</div>
<FileUpload
id="file-upload-1"
name="file-upload-1"
label="Upload a file"
error="The CSV must be smaller than 2MB"
/>
Make sure errors follow the guidance in error message and have specific error messages for specific error states.
If no file has been selected
Say ‘Select a [whatever they need to select]’. For example, ‘Select a report’.
If the file is the wrong file type
Say ‘The selected file must be a [list of file types]’. For example, ‘The selected file must be a CSV or ODS’ or ‘The selected file must be a JPG, BMP, PNG, TIF or PDF’.
If the file is too big
Say ‘The selected file must be smaller than [largest file size]’. For example, ‘The selected file must be smaller than 2MB’.
If the file is empty
Say ‘The selected file is empty’.
If the file contains a virus
Say ‘The selected file contains a virus’.
If the file is password protected
Say ‘The selected file is password protected’.
If there was a problem and the file was not uploaded
Say ‘The selected file could not be uploaded – try again’.
If there is a limit on how many files the user can select
Say ‘You can only select up to [highest number] files at the same time’. For example, ‘You can only select up to 10 files at the same time’.
If the file is not in a template that must be used or the template has been changed
Say ‘The selected file must use the template’.
Research on this component
Read a blog post about design tips for helping users upload things.