Repository files navigation

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 amono-repo from theTOAST UI ImageEditor repository.

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

This is a React component wrappingTOAST UI Image Editor.

• Collect statistics on the use of open source
• Install
  • Using npm
• Usage
  • Import
  • Props
  • Instance Methods
  • Getting the root element
  • Event
• Pull Request Steps
• Documents
• Contributing
• License

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 theusageStatistics props like the example below.

<ImageEditorusageStatistics={false}/>

Or, includetui-code-snippet.js (v1.4.0 orlater) and then immediately write the options as follows:

tui.usageStatistics=false;

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

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 importtui-image-editor.css fromtui-image-editor/dist manually.

• Using ECMAScript module

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

• Using CommonJS module

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

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

constmyTheme={// Theme object to extends default dark theme.};constMyComponent=()=>(<ImageEditorincludeUI={{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}/>);

Importingblack/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.

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

constimageEditorOptions={// sort of option properties.};classMyComponentextendsReact.Component{editorRef=React.createRef();handleClickButton=()=>{consteditorInstance=this.editorRef.current.getInstance();editorInstance.flipX();};render(){return(<><ImageEditorref={this.editorRef}{...imageEditorOptions}/><buttononClick={this.handleClickButton}>Flip image by X Axis!</button></>);}}

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 callgetRootElement to get the element.

classMyComponentextendsReact.Component{editorRef=React.createRef();handleClickButton=()=>{this.editorRef.current.getRootElement().classList.add('image-editor-root');};render(){return(<><ImageEditorref={this.editorRef}{...imageEditorOptions}/><buttononClick={this.handleClickButton}>Click!</button></>);}}

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

classMyComponentextendsReact.Component{handleMousedown=()=>{console.log('Mouse button is downed!');};render(){return(<ImageEditoronMousedown={this.handleMousedown}/>);}}

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.

Forkdevelop 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

Let's start development!

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

For more information on PR's step, please see links of Contributing section.

• Getting Started

• Code of Conduct
• Contributing guideline
• Commit convention

This software is licensed under theMIT ©NHN.