README.md

May 3, 2026 ยท View on GitHub

SunEditor

A lightweight and powerful WYSIWYG editor built with vanilla JavaScript

GitHub License npm npm weekly downloads jsDelivr CDN Test coverage

SunEditor supports all modern browsers without dependencies or polyfills.

๐ŸŒŸ Why SunEditor?

SunEditor is a lightweight, fast, and extensible WYSIWYG editor written in pure JavaScript.
It's easy to integrate, highly customizable, and built for modern web applications.

โšก Key Features

  • No dependencies โ€” Optimized for speed and simplicity
  • Modular architecture โ€” Enable only the plugins you need
  • Responsive UI โ€” Works smoothly on all modern devices
  • Framework-friendly โ€” Easy to use with React, Vue, Svelte, etc.
  • Feature-rich plugin ecosystem, including:
    • @Mentions with autocomplete
    • Advanced table editing & custom layouts
    • Math (LaTeX), drawing, and code block support (with language selector)
    • Markdown view mode (GFM) โ€” edit content as Markdown
    • Built-in media galleries (image, video, audio, file)
    • PDF export, templates, and embedded content (audio/video/iframe)

๐Ÿ“ Content Editing Approach

SunEditor is optimized for structured content (articles, documentation, emails) rather than arbitrary HTML editing. Content is validated and auto-corrected to maintain consistency.

For raw HTML editing needs, see strictMode configuration in the Architecture Guide.

๐ŸŒค Try all plugins in Playground

โญ Contributions welcome! Please refer to Contribution Guidelines and check out our open tasks. โญ


๐ŸŒ Browser Support

SunEditor is built to take advantage of modern browser capabilities.
It does not ship with polyfills by default, but you can add them if your project requires broader compatibility.

Works correctly on the following versions or newer.

Browserโ‰ฅ Version
Chrome119 (Oct 2023)
Edge119 (Nov 2023)
Firefox125 (Apr 2024)
Safari (macOS, iOS)17.2 (Dec 2023)
Opera105 (Nov 2023)
Android WebView119 (Oct 2023)
Samsung Internet23.0 (Oct 2023)
Firefox ESR128 (Jul 2024)

โŒ Not Supported : IE, Legacy Edge

๐Ÿ“Œ Why This Baseline? (Late 2023)

  • This is based on features commonly supported by modern browsers.
  • Most modern web APIs and CSS features are supported reliably in versions after this point.
  • Unless specific compatibility issues arise, you can use it out of the box without additional polyfills.
  • If you need support for older browsers, you can extend it by adding your own polyfills.

๐Ÿ“ฆ Legacy Version (v2-legacy)

* Supported IE11

SunEditor v3 is the latest version.
This section refers to the previous stable version, SunEditor v2.

The v2-legacy branch is no longer actively maintained,
but still available for compatibility with older projects.

๐Ÿ‘‰ v2-legacy branch


๐Ÿš€ Install & Quick Start

๐Ÿ’ก Want to see it in action?
Check out the ๐ŸŒค Live Demo ๐ŸŒค with full options and examples.

NPM

npm install suneditor --save
import 'suneditor/css/editor'; // Editor UI
import 'suneditor/css/contents'; // For displaying HTML
import suneditor from 'suneditor';

// HTML: <div id="editor"></div> or <textarea id="editor"></textarea>
suneditor.create(document.querySelector('#editor'), {
	// options
});

CDN (jsDelivr)

<script src="https://cdn.jsdelivr.net/npm/suneditor@latest/dist/suneditor.min.js"></script>
<link href="https://cdn.jsdelivr.net/npm/suneditor@latest/dist/suneditor.min.css" rel="stylesheet" />
<!-- Optional language (default is English): e.g., Korean (ko) -->
<!-- <script src="https://cdn.jsdelivr.net/npm/suneditor@latest/src/langs/ko.js"></script> -->

<div id="editor"></div>
<!-- or <textarea id="editor"></textarea> -->

<script>
	SUNEDITOR.create(document.querySelector('#editor'), {
		// options
	});
</script>

๐Ÿ”ง Framework Integration

You can use the official wrappers for easier integration:

React โ€“ suneditor-react
Vue โ€“ suneditor-vue


๐Ÿ“ฆ Plugins

SunEditor supports a plugin-based architecture.
You can enable only the plugins you need or even create your own custom ones.

suneditor.create('#editor', {
	plugins: ['font', 'image', 'video'],
	image: {
		uploadUrl: 'https://upload.image',
	},
});

๐Ÿ“˜ Learn how to build your own plugin โ†’

๐Ÿค– Want to build plugins? Get real-time help from SunEditor Devs AI.
See Contribution Guide for tips and examples.


โœจ Contributors

contributors

๐Ÿ’Ž Sponsors

Backers

Backers on Open Collective

Sponsors

Sponsors on Open Collective


๐Ÿ“„ License

SunEditor is an open-source project available under the MIT License.