Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md

README.md

Filerobot Image Editor using filerobot service

Upload the image in your Filerobot storage container, edit it in the Image Editor and upload the result. Deliver lightning fast over CDN.

Requirements

To use the plugin, you will need a Filerobot token. Don't worry, it only takes seconds to get one by registering here. Once your token is created, you can configure it as described below. This token allows you to use 25GB of image cache and 25GB of worldwide CDN traffic per month for free.

Example

<script>
  const config = {
    filerobot: {
      uploadKey: '******',
      container: '******',
      uploadParams: {
        dir: '/'
      }
    }
  };

  const onComplete = function(newUrl, file) {
    console.log('your url for the edited image: ', newUrl);
  };

  const ImageEditor = new FilerobotImageEditor(config, onComplete);

  ImageEditor.open('https://scaleflex.airstore.io/demo/stephen-walker-unsplash.jpg');
</script>

Config/Methods

filerobot: object (required)

filerobot.uploadKey: string (required)

Unique upload key for Filerobot. Subscribe for a Filerobot account to get one. The subscription takes less than a minute and is totally free.

filerobot.container: string (required)

Filerobot Container name.

filerobot.uploadParams: object

  • dir: string (default: '/') - specify the folder where you want to upload the file. If the folder doesn't exist, it will be created.

onComplete(url: string, file: object): function (required)

Callback, triggers on complete processing image.


Go back to Image Editor

You can’t perform that action at this time.