Class FileUpload

File upload component

Hierarchy (View Summary)

ConfigurableComponent
- FileUpload

Index

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:40

Properties

`Protected`_$root

_$root: HTMLElement

_config

_config: FileUploadConfig

$announcements

$announcements: HTMLSpanElement

`Private`$button

$button: HTMLButtonElement

`Private`$input

$input: HTMLFileInputElement

`Private`$status

$status: HTMLSpanElement

enteredAnotherElement

enteredAnotherElement: boolean

`Private`i18n

i18n: I18n

`Private`id

id: string

`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?: Partial<FileUploadConfig>): Partial<FileUploadConfig>
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: Partial<FileUploadConfig>
  Configuration object
Returns Partial<FileUploadConfig>
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:325

hideDraggingState

hideDraggingState(): void
Hides the drop zone visually

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

observeDisabledState

observeDisabledState(): void
Create a mutation observer to check if the input's attributes altered.

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

onChange

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

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

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:342

onDrop

onDrop(event: DragEvent): void
Handles user dropping on the component
Parameters
- event: DragEvent
  The dragenter event
Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:276

showDraggingState

showDraggingState(): void
Show the drop zone visually

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

updateDisabledState

updateDisabledState(): void
Synchronise the disabled state between the input and replacement button.

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

updateDropzoneVisibility

updateDropzoneVisibility(event: DragEvent): void
Updates the visibility of the dropzone as users enters the various elements on the page
Parameters
- event: DragEvent
  The dragenter event
Returns void
- Defined in govuk/components/file-upload/file-upload.mjs:224

`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

Class FileUpload

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FileUpload

Properties

Protected_$root

_config

$announcements

Private$button

Private$input

Private$status

enteredAnotherElement

Privatei18n

Privateid

Static Constantdefaults

See

StaticelementType

StaticmoduleName

Static Constantschema

Satisfies

Accessors

Protected$root

Returns RootElementType

Protectedconfig

Returns ConfigurationType

Methods

[configOverride]

Parameters

Returns Partial<FileUploadConfig>

PrivatefindLabel

Returns HTMLElement

Throws

hideDraggingState

Returns void

observeDisabledState

Returns void

onChange

Returns void

onClick

Returns void

onDrop

Parameters

Returns void

showDraggingState

Returns void

updateDisabledState

Returns void

updateDropzoneVisibility

Parameters

Returns void

StaticcheckSupport

Returns void

Throws

Settings

On This Page

`Protected`_$root

`Private`$button

`Private`$input

`Private`$status

`Private`i18n

`Private`id

`Static` `Constant`defaults

`Static`elementType

`Static`moduleName

`Static` `Constant`schema

`Protected`$root

`Protected`config

`Private`findLabel

`Static`checkSupport