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
  • Import
  • Props
  • Instance Methods
  • Getting the root element
  • Events

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.

1<ImageEditor usageStatistics={false} />

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

1tui.usageStatistics = false;

💾 Install

Using npm

1npm 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

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

• Using CommonJS module

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

Props

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

1const myTheme = {
2  // Theme object to extends default dark theme.
3};
4
5const MyComponent = () => (
6  <ImageEditor
7    includeUI={{
8      loadImage: {
9        path: 'img/sampleImage.jpg',
10        name: 'SampleImage',
11      },
12      theme: myTheme,
13      menu: ['shape', 'filter'],
14      initMenu: 'filter',
15      uiSize: {
16        width: '1000px',
17        height: '700px',
18      },
19      menuBarPosition: 'bottom',
20    }}
21    cssMaxHeight={500}
22    cssMaxWidth={700}
23    selectionStyle={{
24      cornerSize: 20,
25      rotatingPointOffset: 70,
26    }}
27    usageStatistics={true}
28  />
29);

Theme

Importing black/white-theme.js file is not working directly import yet. You want to use a 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.

1const imageEditorOptions = {
2  // sort of option properties.
3};
4
5class MyComponent extends React.Component {
6  editorRef = React.createRef();
7
8  handleClickButton = () => {
9    const editorInstance = this.editorRef.current.getInstance();
10
11    editorInstance.flipX();
12  };
13
14  render() {
15    return (
16      <>
17        <ImageEditor ref={this.editorRef} {...imageEditorOptions} />
18        <button onClick={this.handleClickButton}>Flip image by X Axis!</button>
19      </>
20    );
21  }
22}

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.

1class MyComponent extends React.Component {
2  editorRef = React.createRef();
3
4  handleClickButton = () => {
5    this.editorRef.current.getRootElement().classList.add('image-editor-root');
6  };
7
8  render() {
9    return (
10      <>
11        <ImageEditor ref={this.editorRef} {...imageEditorOptions} />
12        <button onClick={this.handleClickButton}>Click!</button>
13      </>
14    );
15  }
16}

Events

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.

1class MyComponent extends React.Component {
2  handleMousedown = () => {
3    console.log('Mouse button is downed!');
4  };
5
6  render() {
7    return <ImageEditor onMousedown={this.handleMousedown} />;
8  }
9}