Package-level declarations

Types

Link copied to clipboard
external interface FileListOrFileArray

Union of:

Link copied to clipboard
abstract external class InternalUploadManager : UploadManager

An UploadManager subclass used internally by <vaadin-upload>. It reads its configuration from the host component, and overrides the manager behavior where the component behavior that predates the manager integration differs from the standalone manager.

Link copied to clipboard

Attribute names of <vaadin-upload>, for use with setAttribute.

Link copied to clipboard

Attribute names of <vaadin-upload-button>, for use with setAttribute.

Link copied to clipboard

<vaadin-upload-button> is a button component for file uploads. When clicked, it opens a file picker dialog and calls addFiles on a linked UploadManager.

Link copied to clipboard

Attribute names of <vaadin-upload-drop-zone>, for use with setAttribute.

Link copied to clipboard

<vaadin-upload-drop-zone> is a Web Component that can be used as a drop zone for file uploads. When files are dropped on the drop zone, they are added to a linked UploadManager.

Link copied to clipboard

<vaadin-upload> is a Web Component for uploading multiple files with drag and drop support.

Link copied to clipboard

Typed event names of <vaadin-upload>, for use with addEventHandler.

Link copied to clipboard
external interface UploadFile

A file tracked by the upload manager.

Link copied to clipboard

Attribute names of <vaadin-upload-file>, for use with setAttribute.

Link copied to clipboard

<vaadin-upload-file> element represents a file in the file list of <vaadin-upload>.

Link copied to clipboard

Typed event names of <vaadin-upload-file>, for use with addEventHandler.

Link copied to clipboard

Attribute names of <vaadin-upload-file-list>, for use with setAttribute.

Link copied to clipboard
abstract external class UploadFileListElement : HTMLElement, UploadFileListMixin, ThemableMixin, PolylitMixin

<vaadin-upload-file-list> is a Web Component that displays a list of uploaded files. It automatically syncs files from the manager and forwards file events back to it.

Link copied to clipboard
external interface UploadFileListMixin : I18nMixin
Link copied to clipboard

The values exported by @vaadin/upload/src/vaadin-upload-file-list-mixin.js.

Link copied to clipboard
external interface UploadFileMixin : FocusMixin
Link copied to clipboard
external interface UploadFileOrUploadFileArray

Union of:

Link copied to clipboard
abstract external class UploadManager : EventTarget

A pure JavaScript class that manages file upload state and XHR requests. It has no knowledge of UI components - components should listen to events and call methods to interact with the manager.

Link copied to clipboard
external interface UploadMixin : I18nMixin
Link copied to clipboard

The values exported by @vaadin/upload/src/vaadin-upload-mixin.js.

Functions

Link copied to clipboard
fun createUpload(configure: UploadElement.() -> Unit = {}): UploadElement

Creates a <vaadin-upload> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-upload-button> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-upload-drop-zone> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-upload-file> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-upload-file-list> element. The custom element is registered on first use.

Link copied to clipboard
Link copied to clipboard

The class registered by @vaadin/upload/src/vaadin-upload-internal-manager.js.

Link copied to clipboard
external fun parseHeaders(headers: JsAny?)

The headers property also supports a JSON string, while the manager only accepts an object, so strings are parsed. An invalid JSON string parses to undefined, which throws when the request is configured.

Link copied to clipboard

Imports @vaadin/upload/src/vaadin-upload.js, registering <vaadin-upload>, and returns the element class.

Link copied to clipboard

Imports @vaadin/upload/src/vaadin-upload-button.js, registering <vaadin-upload-button>, and returns the element class.

Link copied to clipboard

Imports @vaadin/upload/src/vaadin-upload-drop-zone.js, registering <vaadin-upload-drop-zone>, and returns the element class.

Link copied to clipboard

Imports @vaadin/upload/src/vaadin-upload-file.js, registering <vaadin-upload-file>, and returns the element class.

Link copied to clipboard

Imports @vaadin/upload/src/vaadin-upload-file-list.js, registering <vaadin-upload-file-list>, and returns the element class.

Link copied to clipboard

The class registered by @vaadin/upload/src/vaadin-upload-manager.js.