Package Exports

@upload-io/vue-uploader
@upload-io/vue-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/vue-uploader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vue File Upload Component for Upload.io
(Vue Wrapper for Uploader)

Quick Start — Try on CodePen

To create a file upload button:

npm install @upload-io/vue-uploader

<template>
  <button @click="uploadFile">Upload a file...</button>
</template>

<script>
import { Uploader } from "uploader";
import { uploadFileMethod } from "@upload-io/vue-uploader";

// Create one instance per app. (Get API keys from Upload.io)
const uploader = new Uploader({
  apiKey: "free"
});

// See "customization" below.
const options = {
  multi: true
};

export default {
  name: "App",
  methods: {
    uploadFile: uploadFileMethod({
      uploader,
      options,
      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 @upload-io/vue-uploader

Or via YARN:

yarn add @upload-io/vue-uploader

Or via a <script> tag:

<script src="https://js.upload.io/vue-uploader/v1"></script>

Usage

@upload-io/vue-uploader provides two options:

Option 1) Creating a File Upload Button

Create a file upload button using the uploadFileMethod helper:

<template>
  <button @click="uploadFile">Upload a file...</button>
</template>

<script>
  import { Uploader } from "uploader";
  import { uploadFileMethod } from "@upload-io/vue-uploader";

  // Create one instance per app. (Get API keys from Upload.io)
  const uploader = new Uploader({
    apiKey: "free"
  });

  // See "customization" below.
  const options = {
    multi: true
  };

  export default {
    name: "App",
    methods: {
      uploadFile: uploadFileMethod({
        uploader,
        options,
        onComplete: (files) => {
          if (files.length === 0) {
            console.log("No files selected.");
          } else {
            console.log("Files uploaded:");
            console.log(files.map(f => f.fileUrl));
          }
        }
      })
    }
  };
</script>

Option 2) Creating a Dropzone

Create a file upload dropzone using the UploadDropzone component:

<template>
  <UploadDropzone :uploader="uploader"
                  :options="options"
                  :on-update="onFileUploaded"
                  width="600px"
                  height="375px" />
</template>

<script>
import { Uploader } from "uploader";
import { UploadDropzone } from "@upload-io/vue-uploader";

// One instance per app.
const uploader = new Uploader({ apiKey: "free" });

// See "customization" below.
const options = {
  multi: true
};

export default {
  name: "App",
  components: {
    UploadDropzone
  },
  data() {
    return {
      uploader,
      options
    };
  },
  methods: {
    onFileUploaded: (files) => {
      if (files.length === 0) {
        console.log("No files selected.");
      } else {
        console.log("Files uploaded:");
        console.log(files.map(f => f.fileUrl));
      }
    }
  }
};
</script>

The Result

The onComplete callback receives a 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/vue-uploader is a Vue 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