rx-tui-editor
v1.0.0
Published
GFM Markdown Wysiwyg Editor - Productive and Extensible
Downloads
11
Maintainers
yangning12Readme
🚩 Table of Contents
Collect Statistics on the Use of Open Source
TOAST UI products apply 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 following usageStatistics option when creating the instance.
const options = {
// ...
usageStatistics: false
};
const editor = new Editor(options);📙 Documents
- Getting Started
- APIs
- v3.0 Migration Guide
You can also see the older versions of API page on the releases page.
💾 Install
TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.
Via Package Manager
TOAST UI products are registered in two package managers, npm. You can conveniently install it using the commands provided by the package manager. When using npm, be sure to use it in the environment Node.js is installed.
npm
$ npm install --save @rx-tui-editor/editor # Latest Version
$ npm install --save @rx-tui-editor/editor@<version> # Specific VersionVia Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by NHN Cloud.
You can use the CDN as below.
...
<body>
...
<script src="https://uicdn.toast.com/editor/latest/toastui-editor-all.min.js"></script>
</body>
...If you want to use a specific version, use the tag name instead of latest in the url's path.
The CDN directory has the following structure:
- uicdn.toast.com/
├─ editor/
│ ├─ latest/
│ │ ├─ toastui-editor-all.js
│ │ ├─ toastui-editor-all.min.js
│ │ ├─ toastui-editor-viewer.js
│ │ ├─ toastui-editor-viewer.min.js
│ │ ├─ toastui-editor.css
│ │ ├─ toastui-editor.min.css
│ │ ├─ toastui-editor-viewer.css
│ │ ├─ toastui-editor-viewer.min.css
│ │ ├─ toastui-editor-only.css
│ │ ├─ toastui-editor-only.min.css
│ │ └─ theme/
│ │ ├─ toastui-editor-dark.css
│ │ └─ toastui-editor-dark.min.css
│ │ └─ i18n/
│ │ └─ ...
│ ├─ 2.0.0/
│ │ └─ ...🔨 Usage
First, you need to add the container element where TOAST UI Editor (henceforth referred to as 'Editor') will be created.
...
<body>
<div id="editor"></div>
</body>
...The editor can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.
Using Module Format in Node Environment
- ES6 Modules
import Editor from '@rx-tui-editor/editor';- CommonJS
const Editor = require('@rx-tui-editor/editor');Using Namespace in Browser Environment
const Editor = toastui.Editor;Then, you need to add the CSS files needed for the Editor. Import CSS files in node environment, and add it to html file when using CDN.
Using in Node Environment
import '@rx-tui-editor/editor/dist/toastui-editor.css'; // Editor's StyleUsing in Browser Environment by CDN
...
<head>
...
<!-- Editor's Style -->
<link rel="stylesheet" href="https://uicdn.toast.com/editor/latest/toastui-editor.min.css" />
</head>
...Finally you can create an instance with options and call various API after creating an instance.
const editor = new Editor({
el: document.querySelector('#editor'),
height: '500px',
initialEditType: 'markdown',
previewStyle: 'vertical'
});
editor.getMarkdown();Default Options
height: Height in string or auto ex)300px|autoinitialEditType: Initial type to showmarkdown|wysiwyginitialValue: Initial value. Set Markdown stringpreviewStyle: Preview style of Markdown modetab|verticalusageStatistics: Let us know the hostname. We want to learn from you how you are using the Editor. You are free to disable it.true|false
Find out more options here.