filerobot-image-editor

Filerobot Image Editor

Edit, resize, and filter any image!

The example of Image Editor configuration using cloudimage service can be found here.

See demo

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.

Table of contents

• Standalone usage
  • Installation
  • Quick start
  • Methods
• React component usage
  • Installation
  • Quick start
  • Methods/Properties
• Configuration
• Contributing

Standalone usage

Installation

Use latest CDNized plugin version

<script src="https://scaleflex.airstore.io/filerobot/image-editor/1.0.0/main.min.js"></script>

Quick start

We provide easy way to integrate image editor in your applications

<script>
  const config = {
      filerobotUploadKey: '7cc1f659309c480cbc8a608dc6ba5f03',
      filerobotContainer: 'scaleflex-tests-v5a'
    };

    const onComplete = function(url, file) {
      // do something with new url or file
    }

    FilerobotImageEditor.init(config, onComplete);

    FilerobotImageEditor.open('https://scaleflex.airstore.io/filerobot/assets/filerobot-demo-2-min.jpg');
</script>

Methods

FilerobotImageEditor.init(config: {}, uploadHandler: callback): function

Initialization of Filerobot Image Editor plugin.

FilerobotImageEditor.open(url): function

Open editor modal.

• url: string (required) - image url to edit

FilerobotImageEditor.close(): function

Close editor modal.

FilerobotImageEditor.unmount(): function

Destroy editor

React component usage

Installation

$ npm install --save filerobot-image-editor

Quick start

We provide easy way to integrate image editor in your applications

import React, { Component } from 'react';
import { render } from 'react-dom';
import FilerobotImageEditor from 'filerobot-image-editor';


const config = {
  filerobotUploadKey: '7cc1f659309c480cbc8a608dc6ba5f03',
  filerobotContainer: 'scaleflex-tests-v5a',
};

class App extends Component {
  constructor() {
    super();

    this.state = {
      isShow: false,
      imgSrc: '//scaleflex.airstore.io/filerobot/assets/filerobot-demo-2-min.png'
    }
  }

  showImageEditor = () => {
    this.setState({ isShow: true });
  }

  onComplete = (newUrl) => {
    this.setState({ imgSrc: newUrl });
  }

  onClose = () => {
    this.setState({ isShow: false });
  }

  render() {
    const { imgSrc, isShow } = this.state;

    return (
      <div>
        <h1>Filerobot Image Editor</h1>

          <img src={imgSrc} onClick={this.showImageEditor} alt="example image"/>

        <FilerobotImageEditor
           show={isShow}
           src={imgSrc}
           config={config}
           onComplete={this.onComplete}
           onClose={this.onClose}
        />
      </div>
    )
  }
}

render(<App/>, document.getElementById('app'));

Methods/Properties

show: bool (required)

default: false

Trigger, to display the image editor widget.

config: object (required)

Image editor config.

onClose(): function (required)

Callback, triggers on close image editor widget.

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

Callback, triggers on complete processing image.

Configuration

filerobotContainer: string (required)

Filerobot Container name.

filerobotContainer: 'demo'

filerobotUploadKey: string (required)

Unique upload key for Filerobot.

filerobotUploadKey: 'xxxxxxxxxxxx'

uploadParams: object

see documentation

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

 uploadParams: {
    dir: '/folder_name',
    ...
}

Contributing!

All contributions are super welcome!