Gathering detailed insights and metrics for @toast-ui/editor
Gathering detailed insights and metrics for @toast-ui/editor
🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.
Installations
npm install @toast-ui/editorDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Node Version
15.14.0
NPM Version
7.7.6
Releases
134
Languages
5
TypeScript
CSS
JavaScript
HTML
Vue
TypeScript (85.81%)
CSS (4.99%)
JavaScript (4.96%)
HTML (4.13%)
Vue (0.11%)
Developer
Download Statistics
Total Downloads
17,135,750
Last Day
17,021
Last Week
103,115
Last Month
459,293
Last Year
4,173,478
GitHub Statistics
MIT License
17,669 Stars
361 Commits
1,817 Forks
227 Watchers
56 Branches
113 Contributors
Updated on Aug 31, 2025
Maintainers
2
Package Meta Information
Latest Version
3.2.2
Package Id
@toast-ui/editor@3.2.2
Unpacked Size
3.12 MB
Size
809.55 kB
File Count
69
NPM Version
7.7.6
Node Version
15.14.0
Published on
Feb 17, 2023
Total Downloads
Cumulative downloads
Total Downloads
17,135,750
Last Day
17.4%
17,021
Compared to previous day
Last Week
5.3%
103,115
Compared to previous week
Last Month
24%
459,293
Compared to previous month
Last Year
30%
4,173,478
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
🚩 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.
1const options = { 2 // ... 3 usageStatistics: false 4}; 5 6const 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
1$ npm install --save @toast-ui/editor # Latest Version 2$ npm install --save @toast-ui/editor@<version> # Specific Version
Via Contents Delivery Network (CDN)
TOAST UI products are available over the CDN powered by NHN Cloud.
You can use the CDN as below.
1... 2<body> 3 ... 4 <script src="https://uicdn.toast.com/editor/latest/toastui-editor-all.min.js"></script> 5</body> 6...
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.
1... 2<body> 3 <div id="editor"></div> 4</body> 5...
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
1import Editor from '@toast-ui/editor';
- CommonJS
1const Editor = require('@toast-ui/editor');
Using Namespace in Browser Environment
1const 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
1import '@toast-ui/editor/dist/toastui-editor.css'; // Editor's Style
Using in Browser Environment by CDN
1... 2<head> 3 ... 4 <!-- Editor's Style --> 5 <link rel="stylesheet" href="https://uicdn.toast.com/editor/latest/toastui-editor.min.css" /> 6</head> 7...
Finally you can create an instance with options and call various API after creating an instance.
1const editor = new Editor({ 2 el: document.querySelector('#editor'), 3 height: '500px', 4 initialEditType: 'markdown', 5 previewStyle: 'vertical' 6}); 7 8editor.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.
🦄 Tutorials
No vulnerabilities found.