File dropzone

Overview

A drag-and-drop field for selecting and uploading files. The component supports file type restrictions, multiple file selection, validation for required fields, and minimum/maximum size. File dropzone can also parse text-based files like JSON, CSV, and Excel spreadsheets. You can configure the maximum size for uploaded files.

Properties

Name
Type
Description

name

string

Component name

value

string | File | Blob

Current component value

parsedValue

any

Parsed file content (available only if the Parse file setting is enabled)

valid

boolean

Indicates if the component is valid

validating

boolean

Indicates if the component is validating

disabled

boolean

Indicates whether the component is disabled

The component's parsedValue property allows you to access CSV/JSON file content as an array of objects without uploading files to the server or parsing them separately. You can use it as {{ui.fileDropZone.parsedValue}} in code action steps or directly in other components.

Methods

Name
Parameters
Returns
Description

setValue

value: string | File | Blob

void

Set component value

setDisabled

disabled: boolean

void

Disable or enable the component

reset

โ€“

void

Reset component to the initial value

focus

โ€“

void

Set focus on the component

validate

โ€“

void

Trigger form validation

resetValidation

โ€“

void

Clear validation errors

setErrors

errors: string | string[] | null

void

Mark the component as invalid and display errors

setRequired

required: boolean

void

Set component required state

Triggers

Name
Description

On Change

Triggered when the component's state changes

On Focus

Triggered when the component is in focus

On Blur

Triggered when the component loses focus

On Init

Triggered when the component is initialized

Working with the component

Multi-file upload & Append files settings

The component allows you to upload multiple files - you just need to select the Multiple checkbox in component's settings. Once selected, the Append files option will appear. It allows you to add new files without replacing the existing ones.

Last updated

Was this helpful?