kvision-bootstrap-upload/io.kvision.form.upload/Upload

Upload

open class Upload(uploadUrl: String?, multiple: Boolean, label: String?, rich: Boolean, init: Upload.() -> Unit?)

The form field file upload component.

Parameters

uploadUrl

the optional URL for the upload processing action

multiple

determines if multiple file upload is supported

label

label text bound to the input element

rich

determines if label can contain HTML code

init

an initializer extension function

Constructors

Upload

fun Upload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: Upload.() -> Unit? = null)

Types

Companion

object Companion

Functions

blur

open fun blur()

buildClassSet

open fun buildClassSet(classSetBuilder: <ERROR CLASS>)

cancel

open fun cancel()

Cancel an ongoing ajax upload (only for ajax mode).

clearInput

open fun clearInput()

Clears the file input control (including the native input).

focus

open fun focus()

getNativeFile

open fun getNativeFile(kFile: <ERROR CLASS>): <ERROR CLASS>?

Returns the native JavaScript File object.

getState

open fun getState(): List<<ERROR CLASS>>?

getValueAsString

open fun getValueAsString(): String?

lock

open fun lock()

Locks the file input (disabling all buttons except a cancel button).

removeEventListener

open fun removeEventListener(id: Int): <ERROR CLASS>

removeEventListeners

open fun removeEventListeners(): <ERROR CLASS>

resetInput

open fun resetInput()

Resets the file input control.

setEventListener

open fun <T> setEventListener(block: <ERROR CLASS><T>.() -> Unit): Int

setState

open fun setState(state: List<<ERROR CLASS>>?)

open fun subscribe(observer: (List<<ERROR CLASS>>?) -> Unit): () -> Unit

unlock

open fun unlock()

Unlocks the file input.

upload

open fun upload()

Trigger ajax upload (only for ajax mode).

Properties

allowedFileExtensions

var allowedFileExtensions: Set<String>?

Allowed file extensions.

allowedFileTypes

var allowedFileTypes: Set<String>?

Allowed file types.

browseOnZoneClick

var browseOnZoneClick: Boolean

Determines if the click on the preview zone opens file browse window.

dropZoneEnabled

var dropZoneEnabled: Boolean

Determines if Drag&Drop zone is enabled.

explorerTheme

var explorerTheme: Boolean

Determines if the explorer theme is used.

flabel

val flabel: <ERROR CLASS>

input

val input: UploadInput

invalidFeedback

val invalidFeedback: <ERROR CLASS>

label

var label: <ERROR CLASS>

The label text bound to the spinner input element.

multiple

var multiple: Boolean

Determines if multiple file upload is supported.

placeholder

var placeholder: String?

The placeholder for the upload control.

preferIconicPreview

var preferIconicPreview: Boolean

Determines if the iconic preview is prefered.

required

var required: Boolean

Determines if the input selection is required.

rich

var rich: <ERROR CLASS>

Determines if label can contain HTML code.

showBrowse

var showBrowse: Boolean

Determines if the file browse button is shown.

showCancel

var showCancel: Boolean

Determines if the cancel button is shown.

showCaption

var showCaption: Boolean

Determines if the caption is shown.

showPreview

var showPreview: Boolean

Determines if the preview is shown.

showRemove

var showRemove: Boolean

Determines if the remove button is shown.

showUpload

var showUpload: Boolean

Determines if the upload button is shown.

uploadExtraData

var uploadExtraData: (String, Int) -> dynamic?

The extra data that will be passed as data to the AJAX server call via POST.

uploadUrl

var uploadUrl: String?

The optional URL for the upload processing action. If not set the upload button action will default to form submission.

value

open var value: List<<ERROR CLASS>>?

File input value.