@transloadit/jquery-sdk
Advanced tools
[](https://travis-ci.org/transloadit/jquery-sdk)
Warning: We recommend using Uppy instead of the jQuery SDK these days.
A jQuery Integration for Transloadit's file uploading and encoding service
Transloadit is a service that helps you handle file uploads, resize, crop and watermark your images, make GIFs, transcode your videos, extract thumbnails, generate audio waveforms, and so much more. In short, Transloadit is the Swiss Army Knife for your files.
This is a jQuery SDK to make it easy to talk to the Transloadit REST API. It supports resumable file uploads out of the box including a modal box with a progress bar, drag and drop support and several other nice things. :)
Note You may also be interested in checking out Uppy, Transloadit's next-gen file uploader for the web.
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>
You have an HTML form on your page like this one for example:
<form id="upload-form" action="/uploads" enctype="multipart/form-data" method="POST">
<input type="file" name="my_file" multiple="multiple" />
<div class="transloadit-drop-area">Drag and drop files here</div>
<div class="transloadit-file-preview-area"></div>
<input type="text" name="album_id" value="foo_id" />
<input type="submit" value="Upload">
</form>
By attaching the jQuery SDK to the form you enable uploading functionality on the form:
$('#upload-form').transloadit({
wait: true,
triggerUploadOnFileSelection: true,
params : {
auth : { key : 'YOUR_TRANSLOADIT_KEY' },
template_id : 'YOUR_TEMPLATE_ID'
}
});
Once you select some files over the file input field (or the drag and drop area) a modal will appear that will upload your fils.
The wait parameter set to true instruct the SDK to wait for all transcoding to finish. Once it's finished it will attach a long JSON
string to a hidden textarea in your form.
You can then submit the form as you normally would. On your backend you have an extra POST field named "transloadit" then in the payload including JSON with information about all uploads and transcoding results, their meta data and the URLs to them.
It's that simple. :)
Changes from version 2 to version 3:
uploads anymore. Please use the onUpload callback to track received uploads.translations parameter now that must be used to get your custom locale working.Version 2 of the plugin is CEASEED TO EXIST on September 30, 2017. Please upgrade to version 3 as soon as possible.
The Transloadit jQuery plugin allows you to
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.
Important Your file input fields must each have a proper name attribute for our jQuery SDK to work properly.
Instead of using the plugin's params parameter, you could also have added the Assembly Instructions in a hidden form field named params.
Sometimes, especially when your instructions need to be calculated by a back-end language, and also when you want to add Signature authentication it is easier to specify them directly in the form, than to add them in the call to the jQuery SDK.
The contents of the hidden params field need to be encoded as JSON, with HTML entities escaped. Have your preferred scripting language encode the JSON for you to maintain readability. Here is an example in PHP:
$params = array(
"auth" => array("key" => "YOUR_TRANSLOADIT_KEY"),
"steps" => array(
"resize_to_75" => array(
"robot" => "/image/resize",
"use" => ":original",
"width" => 75,
"height" => 75
)
)
);
printf(
'<input type="hidden" name="params" value="%s" />',
htmlentities(json_encode($params))
);
Your form should then look like this (just with YOUR_TRANSLOADIT_KEY replaced with your real Auth Key):
<form id="upload-form" action="http://api2.transloadit.com/assemblies" enctype="multipart/form-data" method="POST">
<input type="hidden" name="params" value="{"auth":{"key":"YOUR_TRANSLOADIT_KEY"},"steps":{"resize_to_75":{"robot":"\/image\/resize","use":":original","width":75,"height":75}}}" />
<input type="file" name="my_file" />
<input type="submit" value="Upload">
</form>
Both ways of adding the Assembly Instructions are valid. When you upload a file you should see the same result.
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.
We have one magic release:
jquery.transloadit-v3-latest.js
This is always the latest version of the v3 branch and is the recommended version to use. https://assets.transloadit.com/js/jquery.transloadit2-v3-latest.js
You can also pin specific versions via: https://assets.transloadit.com/js/jquery.transloadit2-v3.0.0.js. Remember that it then becomes your responsibility to keep track of security and performance upgrades in our releases.
These can be added as parameters to the .transloadit() call like so:
<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({
onStart: function(assembly) {
console.log('>> Uploading has started!');
},
onExecuting: function(assembly) {
console.log('>> Transcoding has started!');
},
});
});
| Parameter | Description |
|---|---|
| onStart(assemblyObj) | This is fired whenever uploading begins. The assemblyObj contains useful data like the assembly's id. |
| onExecuting(assemblyObj) | This is fired whenever uploading is fully finished and transcoding begins. The assemblyObj contains useful data like the assembly's id. |
|
onFileSelect( fileObject, $fileInputField ) | This is fired whenever a user selects a file in file input field. |
|
onProgress( bytesReceived, bytesExpected ) | This is fired whenever the upload progress is updated, allowing you to render your own upload progress bar. |
| onUpload(upload) |
This is fired once for each uploaded file. This is useful for custom renderings of multiple file uploads.
Each upload here has an ID field. You can map that back to the Please set |
| onResult(step, result) |
This is fired each time a result becomes available for a given Step, and is only available when wait is set to true. This can be used
to show thumbnails for videos or images once they are uploaded.
Results here contain a key |
| onCancel() | This is fired after an upload has been canceled by the user. |
| onError(assembly) | This is fired when upload errors occur. |
| onSuccess(assembly) |
This is fired when the plugin has completed an upload. If wait is set to false, this is fired after the upload finishes. If wait is true, this is fired once all files have been transcoded.
|
| onDisconnect() | This is called whenever the internet connection goes down. Useful in the context of resumable uploads. Transloadit will display a default error message in this case, though, asking the user to keep their browser tab open and wait for the resume. |
| onReconnect() | This is called whenever the internet connection becomes available again after it had been down previously. |
These can be added as parameters to the .transloadit() call like so:
<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,
region: 'eu-west-1'
});
});
| Parameter | Description |
|---|---|
| service |
The service URL to use. By default this is "https://api2.transloadit.com/", which makes use of our entire api and route traffic based on the geolocation of your users.
Setting this parameter overrules the region parameter, which you should also check out.
|
| region |
If you want to temporarily switch to a particular region only, because we are down in the other region, you can set this parameter to either "us-east-1" or "eu-west-1". The SDK will then build the proper service endpoint for you. Make sure to not set a custom service endpoint yourself in this case, as this would overrule the region parameter.
|
| wait |
Specifies whether the plugin should wait for files to be transcoded before submitting the form. This is false by default.
|
| requireUploadMetaData |
Specifies whether the plugin should wait for meta data of uploaded files to first be extracted before it calls the onSuccess callback.
If you set wait to true, this option does not have any effect, because extracting meta of uploaded files is a prerequisite for the files to be transcoded.
However, if you set This option is |
| params |
An object of Assembly instructions that should be executed. For examples please check the minimal integration. This is Here is an example: |
| signature |
Specifies the signature string, which is required if signature authentication is enabled in your account. This is null by default. The old way of providing this in a hidden input field named signature is still valid and will not be deprecated.
Please make sure the signature is calculated in your back-end code, so that your Transloadit Auth Secret is not exposed in your public JavaScript code! |
| modal |
Specifies whether to render the Transloadit overlay and progress bar automatically. This is true by default.
|
autoSubmit
|
Specifies whether to submit the original form automatically once the upload and processing have completed. This is true by default.
|
| processZeroFiles |
Specifies whether to perform processing when the form is submitted with no files selected using the form inputs. This is true by default.
|
| triggerUploadOnFileSelection |
When set to true this triggers the upload to Transloadit as soon as the user has selected a file in any of the form's file input fields. This is false by default.
|
| maxNumberOfUploadedFiles |
When set to an integer value, this is the maximum number of files users can upload. If they exceed this number, then an error will occur. By default this is null, which means no limit.
|
| locale |
The locale to use. The default value is "en". If you use a custom locale, please provide your own localized strings. Please check the bottom of this page for further instructions.
|
| exclude |
Specifies a selector for which any matching input[type=file] elements in the current form will not be uploaded through Transloadit. This is "" by default.
|
| fields |
A CSS selector that specifies the form fields to be sent to Transloadit. This is For example: If you would like to only send some fields, set this parameter to a CSS selector string matching the fields to be sent: If you would like to send all form fields, set this to true: You can also set this to an object of key/value pairs: The fields that you send here will be available as |
| translations | An object of i18n translation strings. Please check below to get the list of all available strings to translate. |
| debug |
Specifies whether Transloadit errors are displayed to end users. If this is set to false, no Transloadit errors will be displayed. Use the onError callback to perform your own logging or presentation. This is true by default.
|
Important For very specific use-cases it may help to take a look at the plugin's source code. You can also always ask us to clarify something or help you with integration.
To enable drag and drop please add a div to your form like as follows:
<div class="transloadit-drop-area" data-name="files">Please drag and drop files here</div>
You can change the text of course and also the value of the data-name attribute. If you do not have the data-name attribute set, we will default it to "files".
This will create a drag and drop area with some default CSS in your form. This is the default CSS for it - feel free to overwrite it in your own CSS files:
.transloadit-drop-area {
padding: 5px;
width: 200px;
height: 75px;
border: 2px dashed #ccc;
}
.transloadit-drop-area.hover {
border: 2px dashed #0af;
}
File preview areas are lists that are automatically populated with the files that will be part of the upload. The user can then review the list prior to the upload and remove some files again if he or she so wishes.
To enable file preview areas, please add a div to your form like as follows:
<div class="transloadit-file-preview-area"></div>
This will create a file preview area with some default CSS in your form. This is the default CSS for it - feel free to overwrite it in your own CSS files:
.transloadit-file-preview-area {
margin: 10px 0;
padding: 5px;
width: 300px;
height: 100px;
overflow-y: auto;
border: 1px solid #ccc;
}
.transloadit-file-preview-area ul {
margin: 0!important;
padding: 0!important;
}
.transloadit-file-preview-area li {
border-top: 1px solid #ddd;
list-style-type: none;
display: inline-block;
width: 100%;
height: 12px;
padding: 1px 3px 3px 3px;
font-size: 11px;
}
.transloadit-file-preview-area li:first-child {
border-top: none;
}
If you don't like the Transloadit progress bar, you can render your own, like this:
$('#upload-form').transloadit({
modal: false,
onProgress: function(bytesReceived, bytesExpected) {
// render your own progress bar!
$('#progress')
.text((bytesReceived / bytesExpected * 100).toFixed(2) + '%');
},
onError: function(assembly) {
alert(assembly.error + ': ' + assembly.message);
}
});
If you like the default Transloadit progress bar but just want to change a few colors, customize these css selectors in your own css.
You can unbind the plugin by calling
$('#upload-form').unbind('submit.transloadit');
You can add your own language strings like so:
var $el = $('#upload-form');
$el.transloadit({
translations: {
'errors.SERVER_CONNECTION_ERROR' : 'Your internet connection seems to be down. Retrying ...',
'errors.SERVER_CONNECTION_ERROR.retries_exhausted' : 'Your internet connection seems to be down. Once it is up and running again please reload your browser window and try again.',
'errors.ASSEMBLY_NOT_FOUND' : 'There was a server problem finding the proper upload. Please reload your browser window and try again.',
'errors.INTERNET_CONNECTION_ERROR_UPLOAD_IN_PROGRESS' : 'Your internet connection seems to be offline. We will automatically retry the upload until the connection works again. Please leave the browser window open.',
'errors.INTERNET_CONNECTION_ERROR_UPLOAD_NOT_IN_PROGRESS': 'Your internet connection seems to be offline. Please leave the browser window open, so that we can retry fetching the status of your upload.',
'errors.MAX_FILES_EXCEEDED' : 'Please select at most %s files.',
'errors.unknown' : 'There was an unknown error.',
'errors.tryAgain' : 'Please reload your browser page and try again.',
'errors.troubleshootDetails' : 'If you would like our help to troubleshoot this, ' + 'please email us this information:',
'cancel' : 'Cancel',
'cancelling' : 'Cancelling ...',
'details' : 'Details',
'startingUpload' : 'Starting upload ...',
'processingFiles' : 'Upload done, now processing files ...',
'uploadProgress' : '%s / %s MB at %s kB/s | %s left',
}
});
Then just replace the English strings with your custom language strings.
You can access the internal uploader object to call methods directly on it like so:
var $el = $('#upload-form');
$el.transloadit({
wait: true
});
var uploader = $el.data('transloadit.uploader');
// then call some methods on the uploader object
uploader.start();
uploader.stop();
// hide the modal if it exists
uploader.hideModal();
// alternatively you could also do it like this
$el.transloadit('start');
$el.transloadit('stop');
Please consult the plugin's source code to see all available methods.
Feel free to fork this project. We will happily merge bug fixes or other small improvements. For bigger changes you should probably get in touch with us before you start to avoid not seeing them merged.
This plugin includes the following dependencies:
A big thanks goes to the authors of these fantastic projects!
The Transloadit jQuery SDK is licensed under the MIT license. The dependencies have their own licenses (MIT, BSD, PUBLIC DOMAIN).
FAQs
[](https://travis-ci.org/transloadit/jquery-sdk)
The npm package @transloadit/jquery-sdk receives a total of 1 weekly downloads. As such, @transloadit/jquery-sdk popularity was classified as not popular.
We found that @transloadit/jquery-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.