suneditor 3.0.0-beta.3 → 3.0.0-beta.30

package/CONTRIBUTING.md

@@ -4,16 +4,14 @@
 
 ## 📘 Introduction
 
-The codebase is written in **JavaScript (ES2020)**, using **JSDoc** for type definitions.  
+The codebase is written in **JavaScript**, using **JSDoc** for type definitions.  
 Node.js **v14 or higher** is required to build and test.
 
 ### 📝 Notes
 
--   Uses modern syntax including:
-    -   Optional chaining (`?.`)
-    -   Nullish coalescing (`??`)
-    -   Private class fields (`#myField`)
--   Polyfills are **not included** – make sure your target environment supports these features.
+-   **Polyfills are not included**. Make sure your target environment (browser or runtime) natively supports these features.
+-   Target ECMAScript version: **ES2022**
+-   Supported browsers: [See Browser Support](./README.md#-browser-support)
 
 ---
 
@@ -27,6 +25,8 @@ Node.js **v14 or higher** is required to build and test.
 
 ## ✅ Before Submitting a PR
 
+> [commit-guide](./guide/commit-types.md)
+
 -   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.
@@ -139,6 +139,8 @@ A quick overview of the `src/` directory:
 
 ## 🚀 Useful Commands
 
+> [scripts-guide](./guide/scripts-guide.md)
+
 ```bash
 # Start local dev server
 npm run dev
@@ -172,8 +174,6 @@ npm run i18n-build
 npm run test
 ```
 
-> [scripts/README](https://github.com/JiHong88/suneditor/blob/develop/scripts/README.md)
-
 ---
 
 Thanks for contributing 💛

package/README.md

@@ -1,6 +1,6 @@
 <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" />
+    <img src="https://suneditor-files.s3.ap-northeast-2.amazonaws.com/docs/se3_logo_title_flat.svg?v=1" alt="SunEditor" width="280" />
   </a>
 </p>
 
@@ -11,6 +11,7 @@
 	<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>
+	<a href="https://codecov.io/gh/jihong88/suneditor" title="Test coverage"><img src="https://codecov.io/gh/jihong88/suneditor/branch/develop/graph/badge.svg" alt="Test coverage" /></a>
 </p>
 
 #
@@ -24,16 +25,16 @@ It's easy to integrate, highly customizable, and built for modern web applicatio
 
 ### 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)
+- ⚡ **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)**
 
@@ -43,23 +44,37 @@ It's easy to integrate, highly customizable, and built for modern web applicatio
 
 ## 🌍 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      |
+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       |
+| ----------------------------------------------------------------------------------------------------------------------------------- | --------------- |
+| ![Chrome](https://img.shields.io/badge/-Chrome-4285F4?logo=GoogleChrome&logoColor=white&style=flat-square)                          | 119 (Oct 2023)  |
+| ![Edge](https://img.shields.io/badge/-Edge-0078D7?logo=MicrosoftEdge&logoColor=white&style=flat-square)                             | 119 (Nov 2023)  |
+| ![Firefox](https://img.shields.io/badge/-Firefox-FF7139?logo=FirefoxBrowser&logoColor=white&style=flat-square)                      | 121 (Dec 2023)  |
+| ![Safari (macOS, iOS)](https://img.shields.io/badge/-Safari-0D96F6?logo=Safari&logoColor=white&style=flat-square)                   | 17.0 (Sep 2023) |
+| ![Opera](https://img.shields.io/badge/-Opera-FF1B2D?logo=Opera&logoColor=white&style=flat-square)                                   | 105 (Nov 2023)  |
+| ![Android WebView](https://img.shields.io/badge/-Android%20WebView-3DDC84?logo=android&logoColor=white&style=flat-square)           | 119 (Oct 2023)  |
+| ![Samsung Internet](https://img.shields.io/badge/-Samsung%20Internet-1428A0?logo=samsunginternet&logoColor=white&style=flat-square) | 23.0 (Oct 2023) |
+| ![Firefox ESR](https://img.shields.io/badge/-FirefoxESR-FF7139?logo=FirefoxBrowser&logoColor=white&style=flat-square)               | 128 (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**.
 
@@ -87,20 +102,7 @@ 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'
+	// options
 });
 ```
 
@@ -117,20 +119,7 @@ suneditor.create(document.querySelector('#editor'), {
 
 <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'
+		// options
 	});
 </script>
 ```
@@ -175,6 +164,12 @@ See [Contribution Guide](./CONTRIBUTING.md#ai-plugin-helper) for tips and exampl
 
 ---
 
+## 💎 Sponsors
+
+[![Financial Contributors on Open Collective](https://opencollective.com/suneditor/contributors.svg?width=890&avatarHeight=64&button=false)](https://opencollective.com/suneditor)
+
+---
+
 ## 📄 License
 
 SunEditor is an open-source project available under the [MIT License](./LICENSE).