Class FileUpload

File upload component

Hierarchy (View Summary)

ConfigurableComponent
- FileUpload

Index

Constructors

Properties

_$root _config $button $label $status $wrapper i18n defaults elementType moduleName schema

Accessors

Methods

[configOverride] findLabel onChange onClick onDragEnter onDragLeaveOrDrop checkSupport

Constructors

constructor

new FileUpload($root: Element, config?: FileUploadConfig): FileUpload
Parameters
- $root: Element
  File input element
- Optionalconfig: FileUploadConfig = {}
  File Upload config
Returns FileUpload
Overrides ConfigurableComponent.constructor
- Defined in govuk/components/file-upload/file-upload.mjs:36

Properties

`Protected`_$root

_$root: HTMLFileInputElement

_config

_config: FileUploadConfig

`Private`$button

$button: HTMLSpanElement

$label

$label: HTMLElement

`Private`$status

$status: HTMLSpanElement

`Private`$wrapper

$wrapper: HTMLDivElement

`Private`i18n

i18n: I18n

`Static` `Constant`defaults

defaults: FileUploadConfig = ...

File upload default config

See

FileUploadConfig

`Static`elementType

elementType: new () => Element = HTMLElement

`Static`moduleName

moduleName: string = 'govuk-file-upload'

Name for the component used when initialising using data-module attributes.

`Static` `Constant`schema

schema: Readonly<{ properties: { i18n: { type: "object" } } }> = ...

File upload config schema

Satisfies

Accessors

`Protected`$root

get $root(): RootElementType
Protected
Returns the root element of the component

Returns RootElementType
- the root element of component
Inherited from ConfigurableComponent.$root
- Defined in govuk/govuk-frontend-component.mjs:27

`Protected`config

get config(): ConfigurationType
Protected
Returns the root element of the component

Returns ConfigurationType
- the root element of component
Inherited from ConfigurableComponent.config
- Defined in govuk/common/configuration.mjs:46

Methods

[configOverride]

"[configOverride]"(param?: ObjectNested): ObjectNested
Internal Virtual
configOverride

Function which defines configuration overrides to prioritize properties from the root element's dataset.

It should take a subset of configuration as input and return a new configuration object with properties that should be overridden based on the root element's dataset. A Symbol is used for indexing to prevent conflicts.
Parameters
- Optionalparam: ObjectNested
  Configuration object
Returns ObjectNested
return - Configuration object
Inherited from ConfigurableComponent.[configOverride]
- Defined in govuk/common/configuration.mjs:36

`Private`findLabel

findLabel(): HTMLElement
Private
Looks up the <label> element associated to the field

Returns HTMLElement
The <label> element associated to the field

Throws
If the <label> cannot be found
- Defined in govuk/components/file-upload/file-upload.mjs:129

onChange

onChange(): void
Check if the value of the underlying input has changed

Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:103

onClick

onClick(): void
When the button is clicked, emulate clicking the actual, hidden file input

Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:146

onDragEnter

onDragEnter(event: DragEvent): void
When a file is dragged over the container, show a visual indicator that a file can be dropped here.
Parameters
- event: DragEvent
  the drag event
Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:156

onDragLeaveOrDrop

onDragLeaveOrDrop(): void
When a dragged file leaves the container, or the file is dropped, remove the visual indicator.

Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:168

`Static`checkSupport

checkSupport(): void
Validates whether components are supported

Returns void
Throws
when the components are not supported
Inherited from ConfigurableComponent.checkSupport
- Defined in govuk/govuk-frontend-component.mjs:99