jQuery SDK
Until Uppy reached 1.0, our jQuery SDK was the recommended way to integrate Transloadit with web browsers. This is no longer the case and we'd now like everybody to use Uppy instead. The form
method of the Robodog Plugin offers a very easy migration for jQuery SDK users.
Install
Simply include the JavaScript asset in your HTML page like so. jQuery >= 1.9 is also required.
<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="//assets.transloadit.com/js/jquery.transloadit2-v3-latest.js"></script>
Usage
The Transloadit jQuery plugin allows you to
- show file upload progress,
- get uploaded results directly without further API queries, and
- wait for upload processing to complete before redirecting to the result page or calling a callback function.
Assuming a form with the ID "upload-form"
(from the minimal integration),
the jQuery plugin can be used like this:
<script src="//assets.transloadit.com/js/jquery.transloadit2-v3-latest.js"></script>
<script type="text/javascript">
// We call .transloadit() after the DOM is initialized:
$(function() {
$('#upload-form').transloadit({
wait : true,
fields: true,
triggerUploadOnFileSelection: true,
params : {
auth : { key : 'YOUR_TRANSLOADIT_KEY' },
steps : {
resize_to_75: {
robot : '/image/resize',
use : ':original',
width : 75,
height : 75
},
// more Steps here
}
}
});
});
</script>
By default, this will display an overlay with a progress bar.
name
attribute for our jQuery SDK to work properly.Example
An example use of this plugin can be found in the examples directory.
To run it, simply replace YOUR_TRANSLOADIT_KEY
(on the HTML file) with your actual Transloadit key and load the html file on your browser.
Documentation
See GitHub for the full documentation.
Related blog posts
- Announcing Version 3.0 of the jQuery SDK October 16, 2017
- Please Upgrade Your Transloadit jQuery SDK May 6, 2015
- Announcing Version 2.4.0 of Our jQuery SDK March 18, 2014
- New jQuery SDK Version 2.1.0 Released! August 8, 2013
- Our jQuery SDK Is Now Open Source! July 22, 2010