⚠️Notice: This repository is deprecated️️️️️

TOAST UI ImageEditor React Wrapper has been managed separately from the TOAST UI ImageEditor repository. As a result of the distribution of these issues, we decided to deprecate each wrapper repository and manage repository as a mono-repo from the TOAST UI ImageEditor repository.

From now on, please submit issues or contributing related to TOAST UI React Wrapper to TOAST UI ImageEditor repository. Thank you🙂.

TOAST UI Image Editor for React

This is a React component wrapping TOAST UI Image Editor.

🚩 Table of Contents

Collect statistics on the use of open source
Install
- Using npm
Usage
Pull Request Steps
Documents
Contributing
License

Collect statistics on the use of open source

React Wrapper of TOAST UI Image Editor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Image Editor is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the usageStatistics props like the example below.

<ImageEditor
  usageStatistics={false}
/>

Or, include tui-code-snippet.js (v1.4.0 or later) and then immediately write the options as follows:

tui.usageStatistics = false;

💾 Install

Using npm

npm install --save @toast-ui/react-image-editor

📊 Usage

Import

You can use Toast UI Image Editor for React as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import tui-image-editor.css from tui-image-editor/dist manually.

Using ECMAScript module

import 'tui-image-editor/dist/tui-image-editor.css'
import ImageEditor from '@toast-ui/react-image-editor'

Using CommonJS module

require('tui-image-editor/dist/tui-image-editor.css');
var ImageEditor = require('@toast-ui/react-image-editor');

Props

All the options of the TOAST UI Image Editor are supported in the form of props.

const myTheme = {
  // Theme object to extends default dark theme.
};

const MyComponent = () => (
  <ImageEditor
    includeUI={{
      loadImage: {
        path: 'img/sampleImage.jpg',
        name: 'SampleImage'
      },
      theme: myTheme,
      menu: ['shape', 'filter'],
      initMenu: 'filter',
      uiSize: {
        width: '1000px',
        height: '700px'
      },
      menuBarPosition: 'bottom'
    }}
    cssMaxHeight={500}
    cssMaxWidth={700}
    selectionStyle={{
      cornerSize: 20,
      rotatingPointOffset: 70
    }}
    usageStatistics={true}
  />
);

Theme

Importing black/white-theme.js file is not working directly import yet. You want to use white theme, please write own theme object by copy and paste.

Instance Methods

For using instance methods of TOAST UI Image Editor, first thing to do is creating Refs of wrapper component using createRef(). But the wrapper component does not provide a way to call instance methods of TOAST UI Image Editor directly. Instead, you can call getInstance() method of the wrapper component to get the instance, and call the methods on it.

const imageEditorOptions = {
  // sort of option properties.
};

class MyComponent extends React.Component {
  editorRef = React.createRef();
  
  handleClickButton = () => {
    const editorInstance = this.editorRef.current.getInstance();

    editorInstance.flipX();
  };

  render() {
    return (
      <>
        <ImageEditor 
          ref={this.editorRef}
          {...imageEditorOptions}
        />
        <button onClick={this.handleClickButton}>Flip image by X Axis!</button>
      </>
    );
  }
}

Getting the root element

An instance of the wrapper component also provides a handy method for getting the root element. If you want to manipulate the root element directly, you can call getRootElement to get the element.

class MyComponent extends React.Component {
  editorRef = React.createRef();
  
  handleClickButton = () => {
    this.editorRef.current.getRootElement().classList.add('image-editor-root');
  };

  render() {
    return (
      <>
        <ImageEditor 
          ref={this.editorRef}
          {...imageEditorOptions} 
        />
        <button onClick={this.handleClickButton}>Click!</button>
      </>
    );
  }
}

Event

All the events of TOAST UI Image Editor are supported in the form of on[EventName] props. The first letter of each event name should be capitalized. For example, for using mousedown event you can use onMousedown prop like the example below.

class MyComponent extends React.Component {
  handleMousedown = () => {
    console.log('Mouse button is downed!');
  };

  render() {
    return (
      <ImageEditor 
        onMousedown={this.handleMousedown}
      />
    );
  }
}

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{your-personal-repo}/[[repo name]].git
$ cd [[repo name]]
$ npm install

Develop

Let's start development!

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

nhn/toast-ui.react-image-editor