A control for uploading multiple files.

The component allows tracking the whole progress of individual file upload. Fully customizable. Check uploader documentation for more detailed description.


var uploader = webix.ui({
    id: "uploader_1",
    value:"Upload file",

Where to start

addDropZone adds uploader drop zone to any HTML element of the page
addFile adds files to the uploader using browser fileApi
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
blur removes the focus from the control
callEvent calls an inner event
define redefines a single configuration property (or a object with properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
fileDialog opens a file browsing dialog on a client machine
focus sets focus to the control
getChildViews returns child views of the calling component
getFormView returns master form for the input
getInputNode gets the HTML element related to the component
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getTopParentView returns the top parent view
getValue returns the current value of the control
hasEvent checks whether the component has the specified event handler
hide hides the view
isEnabled checks whether the view is enabled
isUploaded checks whether all sent files have been uploaded to server
isVisible checks whether the view is visible
mapEvent routes events from one object to another
queryView returns inner element/elements of a widget that correspond(s) to the defined parameters
refresh repaints the component
render renders the specified item or the whole component
resize adjusts the view to a new size
send sends files from uploader body to server
setValue sets a new value for the component
show makes the component visible
stopUpload cancels the current upload
sync allows you to sync two copies of data (all or just a part of it) from one DataCollection to another
unbind breaks "bind" link
unblockEvent cancels events blocking that was enabled by the 'blockEvent' command
onAfterFileAdd fires after a file has been added to the uploader body
onAfterRender occurs immediately after the component has been rendered.
onAfterScroll occurs when some webix view has been scrolled
onBeforeFileAdd fires the moment you try to add file to uploader
onBeforeRender occurs immediately before the component has been rendered
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onDestruct occurs when component destroyed
onEnter fires when the Enter key has been pressed
onFileUpload fires when uploading of a file ends successfully
onFileUploadError fires in case of a server-side error during uploading
onFocus fires when a view gets focus
onItemClick fires after the control has been clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLongTouch fires on holding finger in some position for a certain period of time
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart fires when some webix view has been touched
onUploadComplete fires when all files have been successfully uploaded to the server
onViewResize fires when the size of a view has been changed by resizer
onViewShow fires when any hidden view is shown
accept specifies particular file types that will be accepted for uploading
align the alignment of the control within the parent container
animate defines the type of animation, with which the view is shown, if it is a Multiview cell
apiOnly sets the uploader to the "invisible" mode
autosend enables sending files to a server immediately after they have been added to the uploader
autowidth adjusts button to its text content
borderless used to hide the component borders
click click action handler
container an HTML container (or its ID) where the component should be initialized
css the name of the CSS class or the object with styles that will be applied to the view container
datatype the type of serverside response
directory allows uploading a folder with files
disabled indicates whether an item is enabled
formData extra data that will be sent to the server side along with the file uploading
gravity sets the view gravity
height sets the height of the component
hidden defines whether the view will be hidden initially
hotkey sets a hotkey that triggers button clicking
icon the icon name
id the ID of a widget
inputHeight the height of the input area, or a button's text value area.
inputName sets the name of the uploader input (the button to upload files)
inputWidth the width of the input area, or a button's text value area.
keyPressTimeout a delay between the key press and the action
label sets the text of the label
link sets the component to display values of the files chosen for upload
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
multiple enables uploading of several files at a time.
name name of the control
on allows attaching custom handlers to inner events of the component
popup allows to attach pop-up menu to the button
tooltip sets a popup message next to the item when the cursor points to it
type the type of the button
upload path to the script file that will handle uploading
urlData extra data that will be sent to server side along with the file uploading
value sets the initial value for a control
width sets the width of a widget
$allowsClear a flag that defines whether the list of files can be cleared
$compareValue compares the old value of the control with the one that is going to be set
$cssName name of the widget the CSS of which you want to inherit for a custom widget
$getSize returns the current size of the component
$getValue called each time when component need to get value from related html input
$height the current height of the view
$prepareValue adjusts the value that is going to be set to the format expected by the control
$renderInput called each time when component need to paint control input
$scope scope for resolving event and method names
$setNode defines HTML element for the component
$setSize sets the component size
$setValue called each time when component need to set value in related html input
$skin the method which will be called when skin is defined
$tooltipIn shows a tooltip
$tooltipMove defines the tooltip while the cursor moves over a view or an HTML area
$tooltipOut defines the behavior of a tooltip when the cursor is out of the target widget or HTML area
$updateProgress method for updating progress state
$view reference to the top HTML element of the view
$width the current width of the view
config all options from the initial component configuration
files inner Data Collection which stores files added into the uploader
name indicates the name of the component (a read-only property)
on_click attaches a click behavior for component items with the specified CSS class.
touchable flag, which force touch reaction on touch screen devices
Back to top