Skip to main content

Simple Vault properties

type(string) the type of a control, set it to "simpleVault"
name(string) the name of a control
id(string) the id of a control, auto-generated if not set
value(array) sets the default list of loaded files. Each file object can contain the following properties:
  • id - (string) mandatory, the id of the file
  • status - (string) the status of the file ("queue", "inprogress", "uploaded", or "failed")
  • progress - (number) the progress of the file upload
  • link - (string) optional, the path to the uploaded file on a server. In order to download files from SimpleVault to the computer, file objects must have the link attribute specified with the path to their location on the server.
  • request - (object) optional, an XMLHttpRequest object sent to server when an upload begins
  • path - (string) optional, the path to the file on the computer starting from the name of the folder (in case a folder with files is added)
  • name - (string) optional, the name of the file including the extension (for adding files from a server)
  • size - (number) optional, the size of the file in bytes (for adding files from a server)
width(string|number|"content") the width of a control
height(string|number|"content") the height of a control
padding(string|number) sets padding between a cell and a border of the SimpleVault control
css(string) adds style classes to a control
disabled(boolean) defines whether a control is enabled (false) or disabled (true)
required(boolean) defines whether a control is required
hidden(boolean) defines whether a control is hidden
label(string) specifies a label for a control
labelWidth(string|number) sets the width of the label of a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
labelPosition(string) defines the position of a label: "left"|"top"
helpMessage(string) adds a help message to a control
preMessage(string) a message that contains instructions for interacting with the control
successMessage(string) a message that appears in case of successful validation of the control value
errorMessage(string) a message that appears in case of error during validation of the control value
fieldName(string) optional, sets the name of the file field in the form data that is sent to the server. By default takes its value from the value of the name property, or, if not specified, from the id attribute.
params(object) optional, adds extra parameters for sending an XMLHttpRequest
singleRequest(boolean) defines whether files are sent in one request, false by default
target(string) mandatory, sets an URL to the server-side script that will process file upload