aframe-uploadcare-component

A Uploadcare component for A-Frame.

Usage no npm install needed!

<script type="module">
  import aframeUploadcareComponent from 'https://cdn.skypack.dev/aframe-uploadcare-component';
</script>

README

aframe-uploadcare-component

A Uploadcare component for A-Frame.

For A-Frame.

API

Property Description Default Value
publicKey You uploadcare's public key

Functions

  • upload(value, contentType)
  • download(fileId, callback, binary)

Events

  • Upload
  • uploadcare-upload-started: Upload started.
  • uploadcare-upload-completed Upload completed succesfully:
    • url: Uploadcare CDN url of the uploaded resource.
    • fileInfo: Uploadcare fileInfo object.
  • uploadcare-upload-error: Something went wrong when uploading.
  • uploadcare-upload-progress, {progress: uploadInfo.progress, uploadInfo: uploadInfo})

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.5.0/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-uploadcare-component/dist/aframe-uploadcare-component.min.js"></script>
</head>

<body>
  <a-scene uploadcare="publicKey: asdf-1234-zxcv">
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-uploadcare-component

Then require and use.

require('aframe');
require('aframe-uploadcare-component');

Examples

Upload a JSON

  var sceneEl = document.querySelector('a-scene');
  sceneEl.addEventListener('uploadcare-upload-completed', function (url) { alert('Uploaded: ' + url);});
  sceneEl.upload(jsonObject, 'application/json');

Download a JSON

  var sceneEl = document.querySelector('a-scene');
  sceneEl.download(url, function (data) {
    console.log('Loaded data', data);
  });