Package Exports

@upload-io/jquery-uploader
@upload-io/jquery-uploader/dist/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@upload-io/jquery-uploader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jQuery File Upload Plugin
(jQuery Wrapper for Uploader)

Quick Start — Try on CodePen

To create a file upload button:

<!-- Install jQuery & jQuery Uploader Plugin -->
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="https://js.upload.io/jquery-uploader/v1"></script>

<script>
  // Call once at the start of your app.
  $.uploader.init({
    apiKey: "free"
  });

  // Displays the upload widget on all 'button' element clicks.
  // (You should narrow the selector down before using!)
  $(() => {
    $("button").uploader({
      onComplete: files => {
        if (files.length === 0) {
          console.log('No files selected.')
        } else {
          console.log('Files uploaded:');
          console.log(files.map(f => f.fileUrl));
        }
      }
    });
  });
</script>

Installation

Install via NPM:

npm install jquery @upload-io/jquery-uploader

Or via YARN:

yarn add jquery @upload-io/jquery-uploader

Or via a <script> tag:

<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="https://js.upload.io/jquery-uploader/v1"></script>

Usage

Step 1) Initialize the `uploader` plugin

Call this once only — at the start of your app — before calling $(x).uploader().

// Get production-ready API keys from Upload.io
$.uploader.init({
  apiKey: "free"
});

To display a file upload dialog on click:

$(() => {
  $("button").uploader({
    onComplete: files => {
      if (files.length === 0) {
        console.log('No files selected.')
      } else {
        console.log('Files uploaded:');
        console.log(files.map(f => f.fileUrl));
      }
    }
  });
});

To display a file upload dropzone inline on the page:

$(() => {
  $("div").uploader({
    dropzone: {
      width: "600px",
      height: "375px"
    },
    onUpdate: files => {
      if (files.length === 0) {
        console.log('No files selected.')
      } else {
        console.log('Files uploaded:');
        console.log(files.map(f => f.fileUrl));
      }
    }
  });
});

The Result

All callbacks receive an Array<UploaderResult>:

{
  fileUrl: "https://upcdn.io/FW25...",          // The URL to use when serving this file.

  editedFile: undefined,                        // The edited file (if present). Same as below.

  originalFile: {
    accountId: "FW251aX",                       // The Upload.io account that owns the file.
    file: { ... },                              // DOM file object (from the <input> element).
    fileId: "FW251aXa9ku...",                   // The uploaded file ID.
    fileUrl: "https://upcdn.io/FW25...",        // The uploaded file URL.
    fileSize: 12345,                            // File size in bytes.
    mime: "image/jpeg",                         // File MIME type.
    suggestedOptimization: {
      transformationUrl: "https://upcdn.io/..", // The suggested URL for serving this file.
      transformationSlug: "thumbnail"           // Append to 'fileUrl' to produce the above URL.
    },
    tags: [                                     // Tags manually & auto-assigned to this file.
      { name: "tag1", searchable: true },
      { name: "tag2", searchable: true },
      ...
    ]
  }
}

Full Documentation

@upload-io/jquery-uploader is a jQuery wrapper for uploader.

Please see: Uploader Docs.

Contribute

If you would like to contribute to Uploader:

Add a GitHub Star to the project (if you're feeling generous!).
Determine whether you're raising a bug, feature request or question.
Raise your issue or PR.

License

MIT

@upload-io/jquery-uploader