@licium/react-editor 3.2.3

package/README.md

@@ -0,0 +1,167 @@
+# TOAST UI Editor for React
+
+> This is a [React](https://reactjs.org/) component wrapping [TOAST UI Editor](https://github.com/nhn/tui.editor/tree/master/apps/editor).
+
+[![npm version](https://img.shields.io/npm/v/@toast-ui/react-editor.svg)](https://www.npmjs.com/package/@toast-ui/react-editor)
+
+## 🚩 Table of Contents
+
+- [Collect Statistics on the Use of Open Source](#collect-statistics-on-the-use-of-open-source)
+- [Install](#-install)
+- [Usage](#-usage)
+
+## Collect Statistics on the Use of Open Source
+
+React Wrapper of TOAST UI Editor applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI 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.
+
+```js
+<Editor
+  ...
+  usageStatistics={false}
+/>
+```
+
+## 💾 Install
+
+### Using npm
+
+```sh
+npm install --save @toast-ui/react-editor
+```
+
+## 📝 Usage
+
+### Import
+
+You can use TOAST UI Editor for React as a ECMAScript module or a CommonJS module. As this module does not contain CSS files, you should import `toastui-editor.css` from `@toast-ui/editor` in the script.
+
+- ES Modules
+
+```js
+import '@toast-ui/editor/dist/toastui-editor.css';
+
+import { Editor } from '@toast-ui/react-editor';
+```
+
+- CommonJS
+
+```js
+require('@toast-ui/editor/dist/toastui-editor.css');
+
+const { Editor } = require('@toast-ui/react-editor');
+```
+
+### Props
+
+[All the options of the TOAST UI Editor](https://nhn.github.io/tui.editor/latest/ToastUIEditor) are supported in the form of props.
+
+```js
+import '@toast-ui/editor/dist/toastui-editor.css';
+
+import { Editor } from '@toast-ui/react-editor';
+
+const MyComponent = () => (
+  <Editor
+    initialValue="hello react editor world!"
+    previewStyle="vertical"
+    height="600px"
+    initialEditType="markdown"
+    useCommandShortcut={true}
+  />
+);
+```
+
+### Instance Methods
+
+For using [instance methods of TOAST UI Editor](https://nhn.github.io/tui.editor/latest/ToastUIEditor#addHook), first thing to do is creating Refs of wrapper component using [`createRef()`](https://reactjs.org/docs/refs-and-the-dom.html#creating-refs). But the wrapper component does not provide a way to call instance methods of TOAST UI Editor directly. Instead, you can call `getInstance()` method of the wrapper component to get the instance, and call the methods on it.
+
+```js
+import '@toast-ui/editor/dist/toastui-editor.css';
+
+import { Editor } from '@toast-ui/react-editor';
+
+class MyComponent extends React.Component {
+  editorRef = React.createRef();
+
+  handleClick = () => {
+    this.editorRef.current.getInstance().exec('bold');
+  };
+
+  render() {
+    return (
+      <>
+        <Editor
+          previewStyle="vertical"
+          height="400px"
+          initialEditType="markdown"
+          initialValue="hello"
+          ref={this.editorRef}
+        />
+        <button onClick={this.handleClick}>make bold</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.
+
+```js
+import '@toast-ui/editor/dist/toastui-editor.css';
+
+import { Editor } from '@toast-ui/react-editor';
+
+class MyComponent extends React.Component {
+  editorRef = React.createRef();
+
+  handleClickButton = () => {
+    this.editorRef.current.getRootElement().classList.add('my-editor-root');
+  };
+
+  render() {
+    return (
+      <>
+        <Editor
+          previewStyle="vertical"
+          height="400px"
+          initialEditType="markdown"
+          initialValue="hello"
+          ref={this.editorRef}
+        />
+        <button onClick={this.handleClickButton}>Click!</button>
+      </>
+    );
+  }
+}
+```
+
+### Events
+
+[All the events of TOAST UI Editor](https://nhn.github.io/tui.editor/latest/ToastUIEditor#focus) are supported in the form of `on[EventName]` props. The first letter of each event name should be capitalized. For example, for using `focus` event you can use `onFocus` prop like the example below.
+
+```js
+import '@toast-ui/editor/dist/toastui-editor.css';
+
+import { Editor } from '@toast-ui/react-editor';
+
+class MyComponent extends React.Component {
+  handleFocus = () => {
+    console.log('focus!!');
+  };
+
+  render() {
+    return (
+      <Editor
+        previewStyle="vertical"
+        height="400px"
+        initialEditType="markdown"
+        initialValue="hello"
+        ref={this.editorRef}
+        onFocus={this.handleFocus}
+      />
+    );
+  }
+}
+```

package/dist/esm/index.js

@@ -0,0 +1,164 @@
+/**
+ * TOAST UI Editor : React Wrapper
+ * @version 3.2.3 | Fri Jan 02 2026
+ * @author NHN Cloud FE Development Lab <dl_javascript@nhn.com>
+ * @license MIT
+ */
+
+import React from 'react';
+import Editor from '@toast-ui/editor';
+import Viewer from '@toast-ui/editor/dist/toastui-editor-viewer';
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise */
+
+var extendStatics = function(d, b) {
+    extendStatics = Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+    return extendStatics(d, b);
+};
+
+function __extends(d, b) {
+    if (typeof b !== "function" && b !== null)
+        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+    extendStatics(d, b);
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+}
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+var default_1 = /** @class */ (function (_super) {
+    __extends(default_1, _super);
+    function default_1() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.rootEl = React.createRef();
+        return _this;
+    }
+    default_1.prototype.getRootElement = function () {
+        return this.rootEl.current;
+    };
+    default_1.prototype.getInstance = function () {
+        return this.editorInst;
+    };
+    default_1.prototype.getBindingEventNames = function () {
+        var _this = this;
+        return Object.keys(this.props)
+            .filter(function (key) { return /^on[A-Z][a-zA-Z]+/.test(key); })
+            .filter(function (key) { return _this.props[key]; });
+    };
+    default_1.prototype.bindEventHandlers = function (props) {
+        var _this = this;
+        this.getBindingEventNames().forEach(function (key) {
+            var eventName = key[2].toLowerCase() + key.slice(3);
+            _this.editorInst.off(eventName);
+            _this.editorInst.on(eventName, props[key]);
+        });
+    };
+    default_1.prototype.getInitEvents = function () {
+        var _this = this;
+        return this.getBindingEventNames().reduce(function (acc, key) {
+            var eventName = (key[2].toLowerCase() + key.slice(3));
+            acc[eventName] = _this.props[key];
+            return acc;
+        }, {});
+    };
+    default_1.prototype.componentDidMount = function () {
+        this.editorInst = new Editor(__assign(__assign({ el: this.rootEl.current }, this.props), { events: this.getInitEvents() }));
+    };
+    default_1.prototype.shouldComponentUpdate = function (nextProps) {
+        var instance = this.getInstance();
+        var height = nextProps.height, previewStyle = nextProps.previewStyle;
+        if (height && this.props.height !== height) {
+            instance.setHeight(height);
+        }
+        if (previewStyle && this.props.previewStyle !== previewStyle) {
+            instance.changePreviewStyle(previewStyle);
+        }
+        this.bindEventHandlers(nextProps);
+        return false;
+    };
+    default_1.prototype.componentWillUnmount = function () {
+        this.editorInst.destroy();
+    };
+    default_1.prototype.render = function () {
+        return React.createElement("div", { ref: this.rootEl });
+    };
+    return default_1;
+}(React.Component));
+
+var ViewerComponent = /** @class */ (function (_super) {
+    __extends(ViewerComponent, _super);
+    function ViewerComponent() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.rootEl = React.createRef();
+        return _this;
+    }
+    ViewerComponent.prototype.getRootElement = function () {
+        return this.rootEl.current;
+    };
+    ViewerComponent.prototype.getInstance = function () {
+        return this.viewerInst;
+    };
+    ViewerComponent.prototype.getBindingEventNames = function () {
+        var _this = this;
+        return Object.keys(this.props)
+            .filter(function (key) { return /^on[A-Z][a-zA-Z]+/.test(key); })
+            .filter(function (key) { return _this.props[key]; });
+    };
+    ViewerComponent.prototype.bindEventHandlers = function (props) {
+        var _this = this;
+        this.getBindingEventNames().forEach(function (key) {
+            var eventName = key[2].toLowerCase() + key.slice(3);
+            _this.viewerInst.off(eventName);
+            _this.viewerInst.on(eventName, props[key]);
+        });
+    };
+    ViewerComponent.prototype.getInitEvents = function () {
+        var _this = this;
+        return this.getBindingEventNames().reduce(function (acc, key) {
+            var eventName = (key[2].toLowerCase() + key.slice(3));
+            acc[eventName] = _this.props[key];
+            return acc;
+        }, {});
+    };
+    ViewerComponent.prototype.componentDidMount = function () {
+        this.viewerInst = new Viewer(__assign(__assign({ el: this.rootEl.current }, this.props), { events: this.getInitEvents() }));
+    };
+    ViewerComponent.prototype.shouldComponentUpdate = function (nextProps) {
+        this.bindEventHandlers(nextProps);
+        return false;
+    };
+    ViewerComponent.prototype.componentWillUnmount = function () {
+        this.viewerInst.destroy();
+    };
+    ViewerComponent.prototype.render = function () {
+        return React.createElement("div", { ref: this.rootEl });
+    };
+    return ViewerComponent;
+}(React.Component));
+
+export { default_1 as Editor, ViewerComponent as Viewer };

package/dist/toastui-react-editor.js

@@ -0,0 +1,2 @@
+/*! For license information please see toastui-react-editor.js.LICENSE.txt */
+!function(){"use strict";var t={n:function(e){var n=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(n,{a:n}),n},d:function(e,n){for(var r in n)t.o(n,r)&&!t.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:n[r]})},o:function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r:function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})}},e={};t.r(e),t.d(e,{Editor:function(){return a},Viewer:function(){return d}});var n=function(t,e){return n=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,e){t.__proto__=e}||function(t,e){for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&(t[n]=e[n])},n(t,e)};function r(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Class extends value "+String(e)+" is not a constructor or null");function r(){this.constructor=t}n(t,e),t.prototype=null===e?Object.create(e):(r.prototype=e.prototype,new r)}var o=function(){return o=Object.assign||function(t){for(var e,n=1,r=arguments.length;n<r;n++)for(var o in e=arguments[n])Object.prototype.hasOwnProperty.call(e,o)&&(t[o]=e[o]);return t},o.apply(this,arguments)};Object.create,Object.create;var i=require("react"),s=t.n(i),u=require("@toast-ui/editor"),p=t.n(u),c=function(t){function e(){var e=null!==t&&t.apply(this,arguments)||this;return e.rootEl=s().createRef(),e}return r(e,t),e.prototype.getRootElement=function(){return this.rootEl.current},e.prototype.getInstance=function(){return this.editorInst},e.prototype.getBindingEventNames=function(){var t=this;return Object.keys(this.props).filter((function(t){return/^on[A-Z][a-zA-Z]+/.test(t)})).filter((function(e){return t.props[e]}))},e.prototype.bindEventHandlers=function(t){var e=this;this.getBindingEventNames().forEach((function(n){var r=n[2].toLowerCase()+n.slice(3);e.editorInst.off(r),e.editorInst.on(r,t[n])}))},e.prototype.getInitEvents=function(){var t=this;return this.getBindingEventNames().reduce((function(e,n){return e[n[2].toLowerCase()+n.slice(3)]=t.props[n],e}),{})},e.prototype.componentDidMount=function(){this.editorInst=new(p())(o(o({el:this.rootEl.current},this.props),{events:this.getInitEvents()}))},e.prototype.shouldComponentUpdate=function(t){var e=this.getInstance(),n=t.height,r=t.previewStyle;return n&&this.props.height!==n&&e.setHeight(n),r&&this.props.previewStyle!==r&&e.changePreviewStyle(r),this.bindEventHandlers(t),!1},e.prototype.componentWillUnmount=function(){this.editorInst.destroy()},e.prototype.render=function(){return s().createElement("div",{ref:this.rootEl})},e}(s().Component),a=c,f=require("@toast-ui/editor/dist/toastui-editor-viewer"),l=t.n(f),h=function(t){function e(){var e=null!==t&&t.apply(this,arguments)||this;return e.rootEl=s().createRef(),e}return r(e,t),e.prototype.getRootElement=function(){return this.rootEl.current},e.prototype.getInstance=function(){return this.viewerInst},e.prototype.getBindingEventNames=function(){var t=this;return Object.keys(this.props).filter((function(t){return/^on[A-Z][a-zA-Z]+/.test(t)})).filter((function(e){return t.props[e]}))},e.prototype.bindEventHandlers=function(t){var e=this;this.getBindingEventNames().forEach((function(n){var r=n[2].toLowerCase()+n.slice(3);e.viewerInst.off(r),e.viewerInst.on(r,t[n])}))},e.prototype.getInitEvents=function(){var t=this;return this.getBindingEventNames().reduce((function(e,n){return e[n[2].toLowerCase()+n.slice(3)]=t.props[n],e}),{})},e.prototype.componentDidMount=function(){this.viewerInst=new(l())(o(o({el:this.rootEl.current},this.props),{events:this.getInitEvents()}))},e.prototype.shouldComponentUpdate=function(t){return this.bindEventHandlers(t),!1},e.prototype.componentWillUnmount=function(){this.viewerInst.destroy()},e.prototype.render=function(){return s().createElement("div",{ref:this.rootEl})},e}(s().Component),d=h;module.exports=e}();

package/dist/toastui-react-editor.js.LICENSE.txt

@@ -0,0 +1,21 @@
+/*!
+ * TOAST UI Editor : React Wrapper
+ * @version 3.2.3 | Fri Jan 02 2026
+ * @author NHN Cloud FE Development Lab <dl_javascript@nhn.com>
+ * @license MIT
+ */
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */

package/index.d.ts

@@ -0,0 +1,32 @@
+import { Component } from 'react';
+import ToastuiEditor, { EditorOptions, ViewerOptions, EventMap } from '@licium/editor';
+import ToastuiEditorViewer from '@licium/editor/dist/toastui-editor-viewer';
+
+export interface EventMapping {
+  onLoad: EventMap['load'];
+  onChange: EventMap['change'];
+  onCaretChange: EventMap['caretChange'];
+  onFocus: EventMap['focus'];
+  onBlur: EventMap['blur'];
+  onKeydown: EventMap['keydown'];
+  onKeyup: EventMap['keyup'];
+  onBeforePreviewRender: EventMap['beforePreviewRender'];
+  onBeforeConvertWysiwygToMarkdown: EventMap['beforeConvertWysiwygToMarkdown'];
+}
+
+export type EventNames = keyof EventMapping;
+
+export type EditorProps = Omit<EditorOptions, 'el'> & Partial<EventMapping>;
+export type ViewerProps = Omit<ViewerOptions, 'el'> & Partial<EventMapping>;
+
+export class Editor extends Component<EditorProps> {
+  getInstance(): ToastuiEditor;
+
+  getRootElement(): HTMLElement;
+}
+
+export class Viewer extends Component<ViewerProps> {
+  getInstance(): ToastuiEditorViewer;
+
+  getRootElement(): HTMLElement;
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@licium/react-editor",
+  "version": "3.2.3",
+  "description": "TOAST UI Editor for React",
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "main": "dist/toastui-react-editor.js",
+  "module": "dist/esm/index.js",
+  "scripts": {
+    "test:types": "tsc",
+    "lint": "eslint .",
+    "serve": "snowpack dev",
+    "build": "webpack build && rollup -c"
+  },
+  "homepage": "https://ui.toast.com",
+  "bugs": {
+    "url": "https://github.com/nhn/tui.editor/issues"
+  },
+  "author": "NHN Cloud FE Development Lab <dl_javascript@nhn.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nhn/tui.editor.git",
+    "directory": "apps/react-editor"
+  },
+  "license": "MIT",
+  "browserslist": "last 2 versions, ie 11",
+  "peerDependencies": {
+    "react": "^17.0.1"
+  },
+  "devDependencies": {
+    "@types/react": "^17.0.3",
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1"
+  },
+  "dependencies": {
+    "@licium/editor": "^3.2.2"
+  },
+  "gitHead": "cbc7cab7b3f081a1aaf1d338b8138512ace132b9"
+}