Vue Upload Widget

File upload component for Vue. Supports: image cropping, drag-and-drop, and more.

Installation

To install via NPM:

npm install @bytescale/upload-widget-vue

To install via a script tag:

<script src="https://js.bytescale.com/upload-widget-vue/v4"></script>

Usage

To add file uploads to your web app, use these code snippets:

Option 1: Create an Upload Button

1<template>
2  <button @click="uploadFile">Upload a file...</button>
3</template>
4
5<script lang="ts">
6  import { openUploadModal } from "@bytescale/upload-widget-vue";
7  import type { UploadWidgetConfig, UploadWidgetResult } from "@bytescale/upload-widget";
8  import type { PreventableEvent } from "@bytescale/upload-widget-vue";
9
10  // -----
11  // Configuration:
12  // https://www.bytescale.com/docs/upload-widget#configuration
13  // -----
14  const options: UploadWidgetConfig = {
15    apiKey: "free", // Get API key: https://www.bytescale.com/get-started
16    maxFileCount: 10
17  };
18
19  export default {
20    name: "App",
21    methods: {
22      uploadFile(event: PreventableEvent) {
23        openUploadModal({
24          event,
25          options,
26          onComplete: (files: UploadWidgetResult[]) => {
27            if (files.length === 0) {
28              alert("No files selected.");
29            } else {
30              alert(files.map(f => f.fileUrl).join("\n"));
31            }
32          }
33        })
34      }
35    }
36  };
37</script>

Option 2: Create a Dropzone Area

1<template>
2  <UploadDropzone :options="options"
3                  :on-complete="onFilesUploaded"
4                  :on-update="onFileListChanged"
5                  width="600px"
6                  height="375px" />
7</template>
8
9<script lang="ts">
10  import { UploadDropzone } from "@bytescale/upload-widget-vue";
11  import type { UploadWidgetConfig, UploadWidgetResult, UploadWidgetOnUpdateEvent } from "@bytescale/upload-widget";
12
13  // -----
14  // Configuration:
15  // https://www.bytescale.com/docs/upload-widget#configuration
16  // -----
17  const options: UploadWidgetConfig = {
18    apiKey: "free", // Get API key: https://www.bytescale.com/get-started
19    maxFileCount: 10,
20    showFinishButton: true
21  };
22
23  export default {
24    name: "App",
25    components: {
26      UploadDropzone
27    },
28    data() {
29      return {
30        options
31      };
32    },
33    methods: {
34      onFileListChanged({ uploadedFiles, pendingFiles, failedFiles }: UploadWidgetOnUpdateEvent) {
35        const uploadedFileUrls = uploadedFiles.map(x => x.fileUrl).join("\n");
36        console.log(uploadedFileUrls);
37      },
38      onFilesUploaded(files: UploadWidgetResult[]) {
39        if (files.length === 0) {
40          alert("No files selected.");
41        } else {
42          alert(files.map(f => f.fileUrl).join("\n"));
43        }
44      }
45    }
46  };
47</script>

Special behavior for dropzones:

onComplete only fires when showFinishButton = true (i.e. when the user clicks "Finish").

onUpdate must be used when showFinishButton = false.

Default value: showFinishButton = false

Result

The onComplete callback receives the following:

[
  {
    "accountId": "YOUR_ACCOUNT_ID",
    "filePath": "/uploads/image.jpg",
    "fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
    "originalFile": {
      "accountId": "YOUR_ACCOUNT_ID",
      "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4",
      "filePath": "/uploads/image.jpg",
      "fileUrl": "https://upcdn.io/A623uY2/raw/uploads/image.jpg",
      "lastModified": 1615680311115,
      "metadata": {
        "myCustomField1": true,
        "myCustomField2": {
          "hello": "world"
        },
        "anotherCustomField": 42
      },
      "mime": "image/jpeg",
      "originalFileName": "example.jpg",
      "size": 43182,
      "tags": [
        "example_tag"
      ]
    }
  }
]

See: UploadWidgetResult

The onUpdate callback receives the following:

1{
2  "uploadedFiles": [],
3  "failedFiles": [],
4  "pendingFiles": [
5    {
6      "file": {
7        "name": "my-file.txt",
8        "type": "text/plain",
9        "size": 42
10      }
11    }
12  ]
13}

The uploadedFiles field uses the same structure as the onComplete param above.

Configuration

The options object requires the following object (all fields optional, except for apiKey, which is required):

{
  "apiKey": "public_A623uY2RvnNq1vZ80fYgGyhKN0U7",
  "editor": {
    "images": {
      "allowResizeOnMove": true,
      "crop": true,
      "cropFilePath": Function,
      "cropRatio": 1,
      "cropShape": "circ",
      "preview": true
    }
  },
  "layout": "modal",
  "locale": {
    "addAnotherFileBtn": "Add another file...",
    "addAnotherImageBtn": "Add another image...",
    "cancelBtn": "cancel",
    "cancelBtnClicked": "cancelled",
    "cancelPreviewBtn": "Cancel",
    "continueBtn": "Continue",
    "cropBtn": "Crop",
    "customValidationFailed": "Failed to validate file.",
    "doneBtn": "Done",
    "fileSizeLimitPrefix": "File size limit:",
    "finishBtn": "Finished",
    "finishBtnIcon": true,
    "imageCropNumberPrefix": "Image",
    "maxFilesReachedPrefix": "Maximum number of files:",
    "maxImagesReachedPrefix": "Maximum number of images:",
    "orDragDropFile": "...or drag and drop a file.",
    "orDragDropFileMulti": "...or drag and drop files.",
    "orDragDropImage": "...or drag and drop an image.",
    "orDragDropImageMulti": "...or drag and drop images.",
    "processingFile": "Processing file...",
    "removeBtn": "remove",
    "removeBtnClicked": "removed",
    "submitBtnError": "Error!",
    "submitBtnLoading": "Please wait...",
    "unsupportedFileType": "File type not supported.",
    "uploadFileBtn": "Upload a File",
    "uploadFileMultiBtn": "Upload Files",
    "uploadImageBtn": "Upload an Image",
    "uploadImageMultiBtn": "Upload Images",
    "xOfY": "of"
  },
  "maxFileCount": 1,
  "maxFileSizeBytes": 10485760,
  "metadata": {
    "myCustomField1": true,
    "myCustomField2": {
      "hello": "world"
    },
    "anotherCustomField": 42
  },
  "mimeTypes": [
    "image/jpeg"
  ],
  "multi": false,
  "onInit": Function,
  "onPreUpload": Function,
  "onUpdate": Function,
  "path": {
    "fileName": "image.jpg",
    "fileNameFallback": "image.jpg",
    "fileNameVariablesEnabled": true,
    "folderPath": "/uploads",
    "folderPathVariablesEnabled": true
  },
  "showFinishButton": true,
  "showRemoveButton": true,
  "styles": {
    "breakpoints": {
      "fullScreenHeight": 420,
      "fullScreenWidth": 750
    },
    "colors": {
      "active": "#528fff",
      "error": "#d23f4d",
      "primary": "#377dff",
      "shade100": "#333",
      "shade200": "#7a7a7a",
      "shade300": "#999",
      "shade400": "#a5a6a8",
      "shade500": "#d3d3d3",
      "shade600": "#dddddd",
      "shade700": "#f0f0f0",
      "shade800": "#f8f8f8",
      "shade900": "#fff"
    },
    "fontFamilies": {
      "base": "-apple-system, blinkmacsystemfont, Segoe UI, helvetica, arial, sans-serif"
    },
    "fontSizes": {
      "base": 16
    }
  },
  "tags": [
    "example_tag"
  ]
}

See: UploadWidgetConfig

You can disable image, video, and PDF previews by setting preview: false

You can disable the image cropper by setting crop: false

Transforming Files

You can transform uploaded files using Bytescale's File Processing APIs:

Image Processing API

Read the docs

Video Processing API

Read the docs

Audio Processing API

Read the docs

Antivirus API

Read the docs

Archive Processing API

Read the docs

Building URLs

After uploading a file, you should save its filePath to your DB instead of its fileUrl, and use the UrlBuilder to lazily create URLs:

filePath values are shorter.
filePath values allow you to change the domain in the future (e.g. if you move to a custom CNAME).
filePath values allow you to select different file transformations at runtime (e.g. /raw/, /image/, etc.).

Install the Bytescale JavaScript SDK to use the UrlBuilder:

npm install @bytescale/sdk

Raw Files

Using the UrlBuilder to get raw file URLs (i.e. URLs to original files):

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/raw/example.jpg"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.jpg"
});

You can upload any file type to Bytescale. Use /raw/ when downloading files that don't need to be transformed.

Transformation Presets

Using the UrlBuilder to transform files using transformation presets:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/thumbnail/example.jpg"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.jpg",
  options: {
    transformation: "preset",
    transformationPreset: "thumbnail"
  }
});

Transformation presets are created in the Bytescale Dashboard.

Images

Using the UrlBuilder to transform images using the Image Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Process images with:
// ↪ https://upcdn.io/abc1234/image/example.jpg?w=800&h=600
Bytescale.UrlBuilder.url({
  accountId: "abc1234",
  filePath: "/example.jpg",
  options: {
    transformation: "image",
    transformationParams: {
      "w": 800,
      "h": 600
    }
  }
});

See the Image Processing API for the full list of transformationParams when transformation: "image".

Videos

Using the UrlBuilder to transform videos using the Video Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Process videos with:
// ↪ https://upcdn.io/abc1234/video/example.mov?f=mp4-h264&h=1080
Bytescale.UrlBuilder.url({
  accountId: "abc1234",
  filePath: "/example.mov",
  options: {
    transformation: "video",
    transformationParams: {
      "f": "mp4-h264",
      "h": 1080
    }
  }
});

See the Video Processing API for the full list of transformationParams when transformation: "video".

Audio

Using the UrlBuilder to transform audio using the Audio Processing API:

// import * as Bytescale from "@bytescale/sdk";

// Process audio with:
// ↪ https://upcdn.io/abc1234/audio/example.wav?f=aac&br=192
Bytescale.UrlBuilder.url({
  accountId: "abc1234",
  filePath: "/example.wav",
  options: {
    transformation: "audio",
    transformationParams: {
      "f": "aac",
      "br": 192
    }
  }
});

See the Audio Processing API for the full list of transformationParams when transformation: "audio".

Antivirus

Using the UrlBuilder to scan files for viruses, trojans, and other malware:

// import * as Bytescale from "@bytescale/sdk";

// Returns: "https://upcdn.io/1234abc/antivirus/example.zip"
Bytescale.UrlBuilder.url({
  accountId: "1234abc",
  filePath: "/example.zip",
  options: {
    transformation: "antivirus"
  }
});

See the Antivirus API for full details about the JSON response structure.

Authentication

The Bytescale Upload Widget requires a Bytescale API key, and optionally a JWT:

API keys

You must always pass an apiKey to the Upload Widget configuration object.

With API key auth, the requester has access to the resources configured in the API key's permissions.

Secret API keys: can perform all API operations (see the Bytescale JavaScript SDK).
Public API keys: can perform file uploads and file downloads only. File overwrites, file deletes, and all other destructive operations cannot be performed using public API keys.

You must always use public API keys (e.g. public_***) in your client-side code.

When using public API keys you can optionally pass a JWT to extend the requester's permissions beyond that of the API key. In addition, you can configure your API key to make it reject requests that aren't accompanied by a valid JWT. This prevents users from taking your API key and using it outside of your application.

JWTs are issued by your application and are verified by Bytescale using a public key certificate.

To use JWTs, please use the Bytescale JavaScript SDK AuthManager »

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

Vue Upload Widget

Installation

Usage

Option 2: Create a Dropzone Area

Result

Configuration

Transforming Files

Building URLs

Raw Files

Transformation Presets

Images

Videos

Audio

Archives

Antivirus

Authentication

API keys

JWTs (Optional)

Vue Upload Widget

You are using an outdated browser.