Module: FileUpload

A file upload component.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name	Type	Description
`allowedFileTypes`	Array	The allowed file types.
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`disabled`	boolean	Whether this component should be disabled.
`fileURL`	string	The url for an already uploaded file.
`i18n`	object	Translated strings for the UI.
`id`	string	ID of the file input.
`maxHeight`	string \| number	The maximum height for the image.
`maxWidth`	string \| number	The maximum width for the image.
`name`	string	The name attribute for the file input.
`previewAttributes`	object	Attributes for the preview.
`previewClasses`	Array	Classes for the preview.
`theme`	string	The theme for the component.
`uploadIcon`	string	The icon to show for the upload button.
`uploadIconPrefix`	string	The prefix to use for the upload button icon.
`wrapperAttributes`	object	Custom attributes for the wrapper element.
`wrapperClasses`	string \| Array \| object	Custom classes for the wrapper element.

ref

object | null

Ref to the component.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 10

Returns:

The file upload component.

Type:: JSX.Element

Example

import FileUpload from '@gravityforms/components/react/admin/elements/FileUpload';

return <FileUpload name="file-upload" />;

Methods

(inner) handleRemove() → {void}

Handler for removing file from file upload field.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 191

Returns:

Type:: void

(inner) onFileInputChange(event) → {void}

Handler for change event on file input.

Parameters:

Name	Type	Description
`event`	object	Event object.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 137

Returns:

Type:: void

(inner) onFileInputKeyDown(event) → {void}

Handler for keydown event on file input.

Parameters:

Name	Type	Description
`event`	object	Event object.

Since: 2.0.1
Source: elements/FileUpload/index.js, line 152

Returns:

Type:: void

(inner) onSelectFile(files) → {function}

Handler for selecting a file.

Parameters:

Name	Type	Description
`files`	Array	Array of files.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 109

Returns:

Function to clear timeout.

Type:: function

(inner) onTargetClick(event) → {void}

Handler for click event on file drop target.

Parameters:

Name	Type	Description
`event`	object	Event object.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 169

Returns:

Type:: void

(inner) renderFileOptions() → {string}

Renders allowed file type options.

Since: 1.1.15
Source: elements/FileUpload/index.js, line 207

Returns:

String list of allowed file types.

Type:: string