Class FileUpload

File upload component

Hierarchy (view full)

GOVUKFrontendComponent
- FileUpload

Index

Constructors

Properties

$button $input $status $wrapper config i18n defaults moduleName schema

Methods

onChange onClick onDragLeaveOrDrop onDragOver

Constructors

constructor

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

Properties

`Private`$button

$button: HTMLButtonElement

`Private`$input

$input: HTMLInputElement

`Private`$status

$status: HTMLElement

`Private`$wrapper

$wrapper: HTMLElement

`Private`config

config: FileUploadConfig

`Private`i18n

i18n: I18n

`Static` `Constant`defaults

defaults: FileUploadConfig = ...

File upload default config

See

FileUploadConfig

`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

Methods

onChange

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

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

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

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

onDragOver

onDragOver(): void
When a file is dragged over the container, show a visual indicator that a file can be dropped here.

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