File
vf-file
ajax
boolean
optional
- use JQuery File Upload. File rules will be sent as a stringifiedrules
key.options
object
optional
- plugin options for this field. merged with thefileOptions
form-level option.dest
optional
string
Upload destination to be sent along with the request. Default:/
valueKey
the key in the response, containing the value to be set (i.e the file name). Defaults tovalue
done
function
optional
called when the upload is finished successfully. Defaults to getting and setting the value of the field according to thevalueKey
prop.error
function
optional
called when an error as occured. To trigger this method throw an exception on the server-side. Default (usesbootbox
):function(e, data) { bootbox.alert(e.responseJSON.error.message); }
When an upload was successful and the value was set, the following element will be added:
<span class="VF-Field__file_uploaded
glyphicon
glyphicon-ok"
title="my-file.ext">
</span>