uploadcare-widget
Advanced tools
Uploadcare Widget is an HTML5 file uploader, a part of the Uploadcare ecosystem that fully covers your file handling.
Note: there currently is a new major version of the widget. Check out the stuff under the master branch.
Here’s how you migrate from v2 to v3.
Uploads affect your web or mobile app performance. The widget ensures all of your uploads are fast and hit their target.
It’s provided as a typical JavaScript library and can be easily embedded in your site.
The widget is highly customizable to fit your needs. It supports multi-file uploads, manual crop, and integrates with social media and cloud storage providers.
See the complete widget docs here.
There are a few types of JS bundles:
uploadcare.full.js — a full bundle with built-in jQuery.uploadcare.js — a bundle without built-in jQuery.uploadcare.api.js — a bundle without UI of the widget and built-in jQuery
JavaScript API only.uploadcare.ie8.js — a full bundle with built-in jQuery 1.x for IE 8 support
(widget v. 2.x and below).uploadcare.lang.en.js — a bundle without built-in jQuery, en locale only.Each bundle has its minified version. Just add .min before .js,
e.g. uploadcare.min.js.
By default, uploadcare.min.js is exported for npm and other package managers.
You’re free to choose from the install methods listed below.
npm install uploadcare-widget@2 --save
import uploadcare from 'uploadcare-widget'
Embed our client library via the <script> tag in the <head>
section of each page where you’d like to use Uploadcare Widget.
Here is the CDN link to the current widget version with built-in jQuery,
<script src="https://ucarecdn.com/libs/widget/2.x/uploadcare.full.min.js" charset="utf-8"></script>
Or, if you’re already using jQuery on your page, consider loading the light version of the widget: without built-in jQuery,
<script src="https://code.jquery.com/jquery-2.2.4.min.js" charset="utf-8"></script>
<script src="https://ucarecdn.com/libs/widget/2.x/uploadcare.min.js" charset="utf-8"></script>
Check out the widget docs for more install methods.
Once you’re done with the install, there are two simple steps to take to use the widget.
Set your public key.
This can also sit in the <head> section,
<script>
UPLOADCARE_PUBLIC_KEY = 'YOUR_PUBLIC_KEY';
</script>
Your secret key is not required for the widget; (it’s quite careless for your page to include any secret keys anyway.
Insert widget element into your form,
<input type="hidden" role="uploadcare-uploader" name="my_file" />
By default, the library looks for inputs with the specified
role attribute and places widgets there.
Once a file is uploaded, this <input> gets a
CDN link with a file UUID. Your server then
receives this link, not file content.
We suggest placing the widget somewhere at the top of your form. Unlike regular inputs, our widget starts uploading files immediately after they get selected by a user, not on form submission. That way users can fill out the rest of your form while an upload is in progress. This can be a real time saver.
The widget is highly customizable with widget options. Check out the existing options and ways to set them in UC docs.
You might not want to use all the features that our widget exhibits. Or, perhaps, you might want to redesign the user experience without having to reinvent the wheel. Maybe, you're in pursuit of building a UI on top of the widget. For all of those use cases, we provide a JavaScript API. Feel free to control the default widget with it, or make use of its standalone components that can be combined with your solutions.
Check out the Uploadcare Widget development guide.
If you think you ran into something in Uploadcare libraries which might have security implications, please hit us up at bugbounty@uploadcare.com or Hackerone.
We'll contact you personally in a short time to fix an issue through co-op and prior to any public disclosure.
Issues and PRs are welcome. You can provide your feedback or drop us a support request at hello@uploadcare.com.
FAQs
Uploadcare Widget: file uploader.
The npm package uploadcare-widget receives a total of 17,475 weekly downloads. As such, uploadcare-widget popularity was classified as popular.
We found that uploadcare-widget demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 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
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.