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

BootstrapUpload

open class BootstrapUpload(uploadUrl: String? = null, multiple: Boolean = false, label: String? = null, rich: Boolean = false, init: BootstrapUpload.() -> Unit? = null)

The form field file upload component for Bootstrap.

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

BootstrapUpload

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

Types

object Companion

Functions

open fun blur()

open fun buildClassSet(classSetBuilder: <Error class: unknown class>)

open fun cancel()

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

open fun clearInput()

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

open fun focus()

getFileWithContent

suspend fun BootstrapUpload.getFileWithContent(kFile: <Error class: unknown class>): <Error class: unknown class>

Returns file with the content read.

open fun getNativeFile(kFile: <Error class: unknown class>): <Error class: unknown class>?

Returns the native JavaScript File object.

open fun getState(): List<<Error class: unknown class>>?

getValueAsString

open fun getValueAsString(): String?

open fun lock()

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

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

open fun resetInput()

Resets the file input control.

setEventListener

open fun <T> setEventListener(block: <Error class: unknown class><T>.() -> Unit): Int

open fun setState(state: List<<Error class: unknown class>>?)

open fun subscribe(observer: (List<<Error class: unknown class>>?) -> Unit): () -> Unit

open fun unlock()

Unlocks the file input.

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.

var explorerTheme: Boolean

Determines if the explorer theme is used.

val flabel: <Error class: unknown class>

val input: BootstrapUploadInput

invalidFeedback

val invalidFeedback: <Error class: unknown class>

var label: <Error class: unknown class>

The label text bound to the spinner input element.

var multiple: Boolean

Determines if multiple file upload is supported.

var placeholder: String?

The placeholder for the upload control.

preferIconicPreview

var preferIconicPreview: Boolean

Determines if the iconic preview is prefered.

var required: Boolean

Determines if the input selection is required.

var rich: <Error class: unknown class>

Determines if label can contain HTML code.

var showBrowse: Boolean

Determines if the file browse button is shown.

var showCancel: Boolean

Determines if the cancel button is shown.

var showCaption: Boolean

Determines if the caption is shown.

var showPreview: Boolean

Determines if the preview is shown.

var showRemove: Boolean

Determines if the remove button is shown.

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.

var uploadUrl: String?

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

open var value: List<<Error class: unknown class>>?

File input value.