Toast UI Image Editor that supports React 18

Unfortunately the original Toast UI Image Editor project has not been supported by its original maintainers since April 2022,

We use the package internally in a pilot, and needed to support React 18.

This fork is not being maintained other then for that purpose, bug fixes might be considered on a case by case basis, but features will not be.

Use at your own risk.

Thanks to the original authors for creating the package.

Full featured image editor using HTML5 Canvas. It's easy to use and provides powerful filters.

📦 Packages

• toast-ui.image-editor - Plain JavaScript component implemented by NHN Cloud.
• toast-ui.vue-image-editor - Vue wrapper component is powered by NHN Cloud.
• toast-ui.react-image-editor - React wrapper component is powered by NHN Cloud.

🚩 Table of Contents

• !Toast UI ImageEditor
  • 📦 Packages
  • 🚩 Table of Contents
  • 🌏 Browser Support
  • 💪 Has full features that stick to the basic.
    • Photo manipulation
    • Integration function
    • Powerful filter function
  • 🙆 Easy to apply the size and design you want
    • Can be used everywhere.
    • Nice default & Fully customizable Themes
  • 🎨 Features
  • 🔧 Pull Request Steps
    • Setup
    • Pull Request
  • 📙 Documents
  • 💬 Contributing
  • 🔩 Dependency
  • 🍞 TOAST UI Family
  • 🚀 Used By
  • 📜 License

🌏 Browser Support

Chrome	Internet Explorer	Edge	Safari	Firefox
Yes	10+	Yes	Yes	Yes

💪 Has full features that stick to the basic.

Photo manipulation

• Crop, Flip, Rotation, Drawing, Shape, Icon, Text, Mask Filter, Image Filter

Integration function

• Download, Image Load, Undo, Redo, Reset, Delete Object(Shape, Line, Mask Image...)

Crop	Flip	Rotation	Drawing	Shape
Icon	Text	Mask	Filter

Powerful filter function

• Grayscale, Invert, Sepia, Blur Sharpen, Emboss, RemoveWhite, Brightness, Noise, Pixelate, ColorFilter, Tint, Multiply, Blend

Grayscale	Noise	Emboss	Pixelate

Sepia	Sepia2	Blend-righten	Blend-diff	Invert

Multifly	Tint	Brightness	Remove-white	Sharpen

🙆 Easy to apply the size and design you want

Can be used everywhere.

• Widely supported in browsers including IE10.

• Option to support various display sizes. (allows you to use the editor features on your web pages at least over 550 * 450 sizes)

  

Nice default & Fully customizable Themes

• Has a white and black theme, and you can modify the theme file to customize it.
• Has an API so that you can create your own instead of the built-in.

black - top	black - bottom	white - left	white - right

🎨 Features

• Load image to canvas
• Undo/Redo (With shortcut)
• Crop
• Flip
• Rotation
• Resize
• Free drawing
• Line drawing
• Shape
• Icon
• Text
• Mask Filter
• Image Filter

🔧 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 if there are any errors.

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

Pull Request

Before uploading your PR, run test one last time to check if there are any errors. If it has no errors, commit and then push it!

For more information on PR's steps, please see links in the Contributing section.

📙 Documents

• Getting Started
• Tutorial
• Example
• API

💬 Contributing

• Code of Conduct
• Contributing guideline
• Issue guideline
• Commit convention

🔩 Dependency

• fabric.js = 4.2.0
• tui.code-snippet >= 1.5.0
• tui.color-picker >= 2.2.6

🍞 TOAST UI Family

• TOAST UI Editor
• TOAST UI Grid
• TOAST UI Chart
• TOAST UI Calendar
• TOAST UI Components

🚀 Used By

• NHN Dooray! - Collaboration Service (Project, Messenger, Mail, Calendar, Drive, Wiki, Contacts)
• Catalyst

📜 License

MIT LICENSE