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

UploadInput

open class UploadInput( uploadUrl: String? = null, multiple: Boolean = false, className: String? = null, init: UploadInput.() -> Unit? = null)

The file upload component.

Parameters

uploadUrl

the optional URL for the upload processing action

multiple

determines if multiple file upload is supported

className

CSS class names

init

an initializer extension function

Constructors

UploadInput

fun UploadInput( uploadUrl: String? = null, multiple: Boolean = false, className: String? = null, init: UploadInput.() -> Unit? = null)

Types

Companion

object Companion

Functions

afterDestroy

open fun afterDestroy()

afterInsert

open fun afterInsert(node: <ERROR CLASS>)

bindAllJQueryListeners

open fun bindAllJQueryListeners()

buildAttributeSet

open fun buildAttributeSet(attributeSetBuilder: <ERROR CLASS>)

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).

getNativeFile

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

Returns the native JavaScript File object.

getState

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

getValueAsString

fun getValueAsString(): String?

Returns the value of the file input control as a String.

lock

open fun lock()

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

removeAllJQueryListeners

open fun removeAllJQueryListeners()

render

open fun render(): <ERROR CLASS>

resetInput

open fun resetInput()

Resets the file input control.

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

ajaxSettings

var ajaxSettings: dynamic

Additional ajax settings to pass to the plugin before submitting the ajax request for upload.

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.

disabled

open var disabled: <ERROR CLASS>

Determines if the field is disabled.

dropZoneEnabled

var dropZoneEnabled: Boolean

Determines if Drag&Drop zone is enabled.

explorerTheme

var explorerTheme: Boolean

Determines if the explorer theme is used.

hideThumbnailContent

var hideThumbnailContent: Boolean

Whether to hide the preview content (image, pdf content, text content, etc.) within the thumbnail.

maxFileSize

var maxFileSize: Double?

The maximum file size for upload in KB.

minFileSize

var minFileSize: Double?

The minimum file size for upload in KB.

multiple

var multiple: Boolean

Determines if multiple file upload is supported.

name

open var name: String?

The name attribute of the generated HTML input element.

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.

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.

showUploadStats

var showUploadStats: Boolean

Whether to to display the file upload statistics.

size

open var size: <ERROR CLASS>?

The size of the input (currently not working)

uploadAsync

var uploadAsync: Boolean

Whether the batch upload of multiple files will be asynchronous/in parallel.

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.

validationStatus

open var validationStatus: <ERROR CLASS>?

The validation status of the input.

value

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

File input value.

Extensions

getFileWithContent

suspend fun UploadInput.getFileWithContent(kFile: <ERROR CLASS>): <ERROR CLASS>

Returns file with the content read.