suneditor 3.0.0-alpha.9 → 3.0.0-beta.2

package/CONTRIBUTING.md

@@ -1,36 +1,184 @@
-# Guidelines For Contributing
+# 🌞 Guidelines For Contributing
 
-Coded based on Nodejs@v20 and written in "prototype" syntax.
-Nodejs version14 or higher is required to build or test this project.
+---
 
-## Before submitting an issue
+## 📘 Introduction
 
--   If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: [Getting Started]()
--   Search the [open issue](https://github.com/jihong88/suneditor/issues) and [closed issue](https://github.com/jihong88/suneditor/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before.
--   File an [issue ticket](https://github.com/jihong88/suneditor/issues/new) by providing all the required information.
+The codebase is written in **JavaScript (ES2020)**, using **JSDoc** for type definitions.  
+Node.js **v14 or higher** is required to build and test.
 
-## Before submitting a PR
+### 📝 Notes
 
--   Search the [open issue](https://github.com/swagger-api/swagger-codegen/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change.
--   If no one has suggested something similar, open an ["issue"](https://github.com/swagger-api/swagger-codegen/issues) with your suggestion to gather feedback from the community.
--   It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history.
+-   Uses modern syntax including:
+    -   Optional chaining (`?.`)
+    -   Nullish coalescing (`??`)
+    -   Private class fields (`#myField`)
+-   Polyfills are **not included** – make sure your target environment supports these features.
 
-## How to contribute
+---
 
-### code architecture
+## 🐛 Before Submitting an Issue
 
-### source formatter
+-   Make sure you're using the latest `master` branch. Your issue may already be fixed.
+-   Search the [open issues](https://github.com/jihong88/suneditor/issues) and [closed issues](https://github.com/jihong88/suneditor/issues?q=is%3Aissue+is%3Aclosed) to avoid duplicates.
+-   If your issue is new, [file a ticket](https://github.com/jihong88/suneditor/issues/new) with detailed info, including reproduction steps if possible.
 
-### about css
+---
 
-### Framework guide
+## ✅ Before Submitting a PR
 
-Code change should conform to the programming style guide of the respective languages:
+-   Check that no one is working on the same thing in [open issues](https://github.com/jihong88/suneditor/issues).
+-   For new features or major changes, please open an issue first to gather feedback.
+-   Use a **feature branch** (not `master`) for your pull request.
+-   Make sure your code passes tests and doesn’t break existing functionality.
 
--   Vue: https://suneditor.com/framework-guide/vue
--   React: https://suneditor.com/framework-guide/react
--   Angular: https://suneditor.com/framework-guide/angular
+---
 
-For other languages, feel free to suggest.
+## 🤝 How to Contribute
 
-You may find the current code base not 100% conform to the coding style and we welcome contributions to fix those.
+We welcome code contributions, bug reports, documentation improvements, or plugin ideas!
+
+### 🧹 Code Formatting
+
+-   Use the provided **ESLint** configuration.
+-   4-space indentation
+-   Single quotes (`'`) for strings
+
+---
+
+## 🧩 Plugin Development
+
+SunEditor allows custom plugins using a flexible API.
+
+📘 Start from the [Plugin API Reference](https://suneditor.com/api/plugins)  
+🔍 Or explore the `src/plugins/` folder to see real examples.
+
+---
+
+## 🔁 CI/CD
+
+📦 The `dist/` folder is **not included** in the git repository.  
+⚙️ It is automatically built and deployed via **GitHub Actions** after changes are pushed to the `release` branch.  
+🛑 **Do not build or commit `dist/` files manually** – this may cause merge conflicts.  
+✅ The CI/CD pipeline ensures clean and consistent builds for every release.
+
+---
+
+## ⚙️ Framework Guide
+
+If you're contributing to framework integrations:
+
+-   React: [suneditor-react](https://github.com/JiHong88/suneditor-react)
+-   Vue: [suneditor-vue](https://github.com/JiHong88/suneditor-vue)
+
+💡 Feel free to propose wrappers for other frameworks too!
+
+---
+
+## 🤖 AI Plugin Helper
+
+Need real-time help?
+
+Check out **[SunEditor Devs AI](https://chatgpt.com/g/g-JViNPCrkD-suneditor-devs)** –
+
+> 💡 Just paste your code or describe your plugin idea – and get instant support.
+
+---
+
+## 🗂️ Code Architecture
+
+A quick overview of the `src/` directory:
+
+### `/core/` – 🧠 Editor Core Logic
+
+-   `editor.js`: Defines the main Editor class, managing lifecycle, commands, and overall orchestration
+-   `section/`: Context management and document setup
+-   `class/`: Core classes like toolbars, selections, HTML parsing, etc.
+-   `base/`: Undo/redo history, event manager, and shared core logic
+
+### `/helper/` – 🛠️ Utility Functions
+
+-   String converters, clipboard helpers, DOM queries
+-   `helper/dom/`: Low-level DOM operations
+
+### `/modules/` – 🧩 Reusable UI Modules
+
+-   Functional components like:
+    -   `Modal`, `ColorPicker`, `SelectMenu`, `FileManager`, etc.
+-   Useful for building consistent plugin UIs
+
+### `/editorInjector/` – 🧬 Plugin Integration Point
+
+-   Wraps and initializes the core editor
+-   Plugins must inherit from this to register correctly
+
+### `/plugins/` – ✨ Feature Extensions
+
+-   Modular plugins organized by type:
+    -   Examples: `image`, `video`, `link`, `blockquote`, etc.
+-   Each plugin is isolated and optional
+
+### `/langs/` – 🌍 i18n Support
+
+-   Language packs in separate JS files
+
+### `/assets/` – 🎨 Styles & Icons
+
+-   CSS for editor layout and themes
+-   SVG icon sets (`icons/defaultIcons.js`)
+
+### `/themes/` – 🧪 Theme Stylesheets
+
+-   Includes variants like `dark.css`
+
+### `suneditor.js` – 🚪 Main Entry Point
+
+-   Bootstraps and exports the editor instance
+
+---
+
+## 🚀 Useful Commands
+
+```bash
+# Start local dev server
+npm run dev
+
+# Build for development
+npm run build:dev
+
+# Build for production
+npm run build:prod
+
+# lint
+npm run lint
+
+# Auto-fix JavaScript issues
+npm run lint:fix-js
+
+# Auto-fix TypeScript issues
+npm run lint:fix-ts
+
+# ✅ Run before committing!
+# Fix all lint issues (JS + TS)
+npm run lint:fix-all
+
+# Build types and update barrels
+npm run ts-build
+
+# Sync language files (base: en.js)
+npm run i18n-build
+
+# test
+npm run test
+```
+
+> [scripts/README](https://github.com/JiHong88/suneditor/blob/develop/scripts/README.md)
+
+---
+
+Thanks for contributing 💛
+You're helping make SunEditor better for everyone!
+
+```
+
+```

package/{LICENSE.txt → LICENSE}

@@ -1,13 +1,13 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2017 ~ Yi JiHong
+Copyright (c) 2017-2025 Yi JiHong
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,42 +1,180 @@
-# SunEditor
-Vanilla javscript based WYSIWYG web editor.
-SunEditor supports all modern browsers except IE without any dependencies and polyfills.
+<p align="center">
+  <a href="https://suneditor.com" target="_blank">
+    <img src="https://suneditor-files.s3.ap-northeast-2.amazonaws.com/docs/se3_logo_title_flat.svg" alt="SunEditor" width="280" />
+  </a>
+</p>
 
-#### 🌤 Demo : <a href="http://suneditor.com" target="_blank">suneditor.com</a> 🌤
+<p align="center"><em>A lightweight and powerful WYSIWYG editor built with vanilla JavaScript</em></p>
 
-⭐ If you would like to contribute, please refer to [guidelines](/CONTRIBUTING.md) and a list of [open tasks](https://github.com/jihong88/suneditor/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).⭐
+<p align="center">
+	<a href="https://github.com/JiHong88/SunEditor/blob/master/LICENSE" title="MIT License"><img src="https://img.shields.io/github/license/jihong88/suneditor.svg?style=flat-square" alt="GitHub License"></a>
+	<a href="https://www.npmjs.com/package/suneditor" title="npm release"><img src="https://img.shields.io/npm/v/suneditor.svg?style=flat-square" alt="npm"></a>
+	<a href="https://www.npmjs.com/package/suneditor" title="npm month downloads"><img src="https://img.shields.io/npm/dm/suneditor.svg?logo=npm&style=flat-square" alt="npm weekly downloads"></a>
+	<a href="https://www.jsdelivr.com/package/npm/suneditor" title="jsDelivr CDN month downloads"><img src="https://img.shields.io/jsdelivr/npm/hm/suneditor?label=CDN&style=flat-square" alt="jsDelivr CDN" /></a>
+</p>
 
-[![GitHub](https://img.shields.io/github/license/jihong88/suneditor.svg?style=flat-square)](https://github.com/JiHong88/SunEditor/blob/master/LICENSE.txt)
-[![GitHub release](https://img.shields.io/github/release/jihong88/suneditor.svg?style=flat-square)](https://github.com/JiHong88/SunEditor/releases)
-[![npm version](https://img.shields.io/npm/v/suneditor.svg?style=flat-square)](https://www.npmjs.com/package/suneditor)
-[![](https://data.jsdelivr.com/v1/package/npm/suneditor/badge)](https://www.jsdelivr.com/package/npm/suneditor)
-[![npm](https://img.shields.io/npm/dt/suneditor.svg?style=flat-square)](https://www.npmjs.com/package/suneditor)
-![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/suneditor.svg?style=flat-square)
+#
 
-![WYSIWYG HTML Editor](http://suneditor.com/docs/screen-main-w.png?v=2700)
+SunEditor supports all modern browsers without dependencies or polyfills.
 
-#### Browser Support
+## 🌟 Why SunEditor?
 
-| <img src="http://suneditor.com/docs/chrome-64.png" alt="Chrome" width="16px" height="16px" /> Chrome | <img src="http://suneditor.com/docs/mozilla-64.png" alt="Firefox" width="16px" height="16px" /> Firefox | <img src="http://suneditor.com/docs/opera-64.png" alt="Opera" width="16px" height="16px" /> Opera | <img src="http://suneditor.com/docs/safari-64.png" alt="Safari" width="16px" height="16px" /> Safari | <img src="http://suneditor.com/docs/edge-64.png" alt="Edge" width="16px" height="16px" /> Edge |
-|:---:|:---:|:---:|:---:|:---:|
-| Yes | Yes | Yes | Yes | Yes |
+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.
 
-## Install
-#### Npm
-``` sh
-$ npm install suneditor --save
+### 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
+    -   📂 Built-in media galleries (image, video, audio, file)
+    -   📄 PDF export, templates, and embedded content (audio/video/iframe)
+
+🌤 **[Explore all plugins](https://suneditor.com/plugins)**
+
+⭐ **Contributions welcome!** Please refer to [Contribution Guidelines](/CONTRIBUTING.md) and check out our [open tasks](https://github.com/jihong88/suneditor/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). ⭐
+
+---
+
+## 🌍 Browser Support
+
+| Browser                                                                                                                             | Since    | Version ≥ |
+| ----------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
+| ![Chrome](https://img.shields.io/badge/-Chrome-4285F4?logo=GoogleChrome&logoColor=white&style=flat-square)                          | Feb 2020 | 80        |
+| ![Firefox](https://img.shields.io/badge/-Firefox-FF7139?logo=FirefoxBrowser&logoColor=white&style=flat-square)                      | Mar 2020 | 74        |
+| ![Safari](https://img.shields.io/badge/-Safari-0D96F6?logo=Safari&logoColor=white&style=flat-square)                                | Mar 2020 | 13.1      |
+| ![Edge](https://img.shields.io/badge/-Edge-0078D7?logo=MicrosoftEdge&logoColor=white&style=flat-square)                             | Jan 2020 | 80        |
+| ![Opera](https://img.shields.io/badge/-Opera-FF1B2D?logo=Opera&logoColor=white&style=flat-square)                                   | Feb 2020 | 67        |
+| ![iOS Safari](https://img.shields.io/badge/-iOS%20Safari-000000?logo=apple&logoColor=white&style=flat-square)                       | Mar 2020 | 13.4      |
+| ![Android WebView](https://img.shields.io/badge/-Android%20WebView-3DDC84?logo=android&logoColor=white&style=flat-square)           | Feb 2020 | 80        |
+| ![Samsung Internet](https://img.shields.io/badge/-Samsung%20Internet-1428A0?logo=samsunginternet&logoColor=white&style=flat-square) | Apr 2020 | 11.1      |
+
+❌ Not Supported : IE, Legacy Edge
+
+---
+
+## 📦 Legacy Version (v2-legacy)
+
+> **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](https://github.com/JiHong88/SunEditor/tree/v2-legacy)
+
+---
+
+## 🚀 Install & Quick Start
+
+> 💡 **Want to see it in action?**  
+> Check out the 🌤 [**Live Demo**](https://suneditor.com) 🌤 with full options and examples.
+
+### NPM
+
+```bash
+npm install suneditor --save
+```
+
+```js
+import 'suneditor/dist/suneditor.min.css';
+import suneditor from 'suneditor';
+
+// HTML: <div id="editor"></div> or <textarea id="editor"></textarea>
+suneditor.create(document.querySelector('#editor'), {
+	buttonList: [
+		['undo', 'redo'],
+		'|',
+		['bold', 'underline', 'italic', 'strike', '|', 'subscript', 'superscript'],
+		'|',
+		['removeFormat'],
+		'|',
+		['outdent', 'indent'],
+		'|',
+		['fullScreen', 'showBlocks', 'codeView'],
+		'|',
+		['preview', 'print', 'copy']
+	],
+	height: 'auto'
+});
 ```
-#### CDN
-``` html
-<link href="https://cdn.jsdelivr.net/npm/suneditor@latest/dist/css/suneditor.min.css" rel="stylesheet">
-<!-- <link href="https://cdn.jsdelivr.net/npm/suneditor@latest/assets/suneditor.css" rel="stylesheet"> -->
-<!-- <link href="https://cdn.jsdelivr.net/npm/suneditor@latest/assets/suneditor-contents.css" rel="stylesheet"> -->
+
+### CDN ([jsDelivr](https://www.jsdelivr.com/package/npm/suneditor))
+
+```html
 <script src="https://cdn.jsdelivr.net/npm/suneditor@latest/dist/suneditor.min.js"></script>
-<!-- languages (Basic Language: English/en) -->
-<script src="https://cdn.jsdelivr.net/npm/suneditor@latest/src/langs/ko.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'), {
+		buttonList: [
+			['undo', 'redo'],
+			'|',
+			['bold', 'underline', 'italic', 'strike', '|', 'subscript', 'superscript'],
+			'|',
+			['removeFormat'],
+			'|',
+			['outdent', 'indent'],
+			'|',
+			['fullScreen', 'showBlocks', 'codeView'],
+			'|',
+			['preview', 'print', 'copy']
+		],
+		height: 'auto'
+	});
+</script>
 ```
-[jsdelivr/suneditor](https://www.jsdelivr.com/package/npm/suneditor)
 
+---
+
+## 🔧 Framework Integration
+
+You can use the official wrappers for easier integration:
+
+React – [suneditor-react](https://github.com/JiHong88/suneditor-react)\
+Vue – [suneditor-vue](https://github.com/JiHong88/suneditor-vue)
+
+---
+
+## 📦 Plugins
+
+SunEditor supports a plugin-based architecture.\
+You can enable only the plugins you need or even create your own custom ones.
+
+```js
+suneditor.create('#editor', {
+	plugins: ['font', 'image', 'video'],
+	image: {
+		uploadUrl: 'https://upload.image'
+	}
+});
+```
+
+📘 [Learn how to build your own plugin →](https://suneditor.com/plugins)
+
+🤖 Want to build plugins? Get real-time help from [SunEditor Devs AI](https://chatgpt.com/g/g-JViNPCrkD-suneditor-devs).\
+See [Contribution Guide](./CONTRIBUTING.md#ai-plugin-helper) for tips and examples.
+
+---
+
+## ✨ Contributors
+
+<a href="https://github.com/jihong88/suneditor/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=jihong88/suneditor" alt="contributors"/>
+</a>
+
+---
+
+## 📄 License
 
-## License
-Suneditor may be freely distributed under the MIT license.
+SunEditor is an open-source project available under the [MIT License](./LICENSE).