❀Narnia Protect Me

    @upload-io/jquery-uploader
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.5Β β€’Β PublicΒ β€’Β Published

    jQuery Uploader

    jQuery File Upload Widget
    (With Integrated Cloud Storage)

    jQuery Wrapper for Uploader β€’ Developed by Upload.io


    Twitter URL

    Quick Start β€” Try on CodePen

    Upload Widget Demo

    To implement the above widget:

    <!-- 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"
    });

    Step 2) Display the Upload Widget

    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

    jQuery Uploader is a wrapper for Uploader β€” see the Uploader Docs πŸ“–

    Where are my files stored?

    Uploader uses Upload.io as a file storage & file hosting backend.

    Upload.io benefits developers with:

    • Zero Setup (Start uploading in the next few minutes!)
    • Pre-Integrated Storage (All you need is an Upload API key)
    • Fast File Hosting (Worldwide CDN, 300 Nodes)
    • Powerful Rules Engine (Rate Limiting, Traffic Limiting, IP Blacklisting, Expiring Links, etc)
    • File Transformations (Image Resizing, Cropping, Optimization, etc)

    πŸ”§ Can I bring my own file storage?

    Uploader's USP is to provide the fastest way to integrate end-to-end file uploads into a web app, while remaining customizable. As such, Uploader will always be closely integrated with the Upload.io platform, and there are currently no plans to support custom backends. You may, however, sync files from your Upload.io account to a custom storage target.

    Contribute

    If you would like to contribute to Uploader:

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

    License

    MIT

    Install

    npm i @upload-io/jquery-uploader

    DownloadsWeekly Downloads

    1,482

    Version

    1.4.5

    License

    MIT

    Unpacked Size

    660 kB

    Total Files

    37

    Last publish

    Collaborators

    • upload-io