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

BootstrapUploadInput

open class BootstrapUploadInput(uploadUrl: String? = null, multiple: Boolean = false, className: String? = null, init: BootstrapUploadInput.() -> Unit? = null) : Widget, GenericFormComponent<List<KFile>?> , FormInput, MutableState<List<KFile>?> (source)

The file upload component for Bootstrap

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

BootstrapUploadInput

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

Types

Companion

object Companion

Properties

ajaxSettings

var ajaxSettings: dynamic

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

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

allowedFileExtensions

var allowedFileExtensions: Set<String>?

Allowed file extensions.

allowedFileTypes

var allowedFileTypes: Set<String>?

Allowed file types.

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

browseOnZoneClick

var browseOnZoneClick: Boolean

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

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

disabled

open override var disabled: Boolean

Determines if the field is disabled.

display

open var display: Display?

draggable

var draggable: Boolean?

dropZoneEnabled

var dropZoneEnabled: Boolean

Determines if Drag&Drop zone is enabled.

eventTarget

var eventTarget: Widget?

explorerTheme

var explorerTheme: Boolean

Determines if the explorer theme is used.

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

height

open var height: CssSize?

hideThumbnailContent

var hideThumbnailContent: Boolean

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

var id: String?

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxFileSize

var maxFileSize: Double?

The maximum file size for upload in KB.

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

minFileSize

var minFileSize: Double?

The minimum file size for upload in KB.

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

multiple

var multiple: Boolean

Determines if multiple file upload is supported.

name

open override var name: String?

The name attribute of the generated HTML input element.

opacity

open var opacity: Double?

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

placeholder

var placeholder: String?

The placeholder for the upload control.

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

preferIconicPreview

var preferIconicPreview: Boolean

Determines if the iconic preview is prefered.

required

var required: Boolean

Determines if the input selection is required.

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

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 override var size: InputSize?

The size of the input (currently not working)

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

unicodeBidi

open var unicodeBidi: UnicodeBidi?

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 override var validationStatus: ValidationStatus?

The validation status of the input.

value

open override var value: List<KFile>?

File input value.

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

zIndex

open var zIndex: Int?

Functions

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

blur

open fun blur()

cancel

open fun cancel()

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

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

clearInput

open fun clearInput()

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

clearParent

open override fun clearParent()

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getFileWithContent

suspend fun BootstrapUploadInput.getFileWithContent(kFile: KFile): KFile

Returns file with the content read.

getNativeFile

fun getNativeFile(kFile: KFile): File?

Returns the native JavaScript File object.

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getState

open override fun getState(): List<KFile>?

getStyle

fun getStyle(name: String): String?

getValueAsString

fun getValueAsString(): String?

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

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide()

lock

open fun lock()

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

refresh

open override fun refresh()

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

removeCssClass

open override fun removeCssClass(css: String)

removeCssStyle

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

removeStyle

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

renderVNode

open override fun renderVNode(): VNode

resetInput

open fun resetInput()

Resets the file input control.

setAttribute

open override fun setAttribute(name: String, value: String)

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setState

open override fun setState(state: List<KFile>?)

setStyle

fun setStyle(name: String, value: String)

show

open fun show()

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

open override fun subscribe(observer: (List<KFile>?) -> Unit): () -> Unit

toggleVisible

open fun toggleVisible()

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

unlock

open fun unlock()

Unlocks the file input.

upload

open fun upload()

Trigger ajax upload (only for ajax mode).

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()