suneditor 3.0.0-beta.9 → 3.0.0-rc.1

package/README.md

@@ -1,16 +1,17 @@
 <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>
 
 <p align="center"><em>A lightweight and powerful WYSIWYG editor built with vanilla JavaScript</em></p>
 
 <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://github.com/JiHong88/SunEditor/blob/master/LICENSE.txt" 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>
+	<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,18 +25,24 @@ 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)**
+### 📝 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](./ARCHITECTURE.md#content-filtering-strictmode) in the Architecture Guide.
+
+🌤 **[Try all plugins in Playground](https://suneditor.com/playground)**
 
 ⭐ **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). ⭐
 
@@ -43,23 +50,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**.
 
@@ -82,25 +103,13 @@ npm install suneditor --save
 ```
 
 ```js
-import 'suneditor/dist/suneditor.min.css';
+import 'suneditor/css'; // 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'), {
-	buttonList: [
-		['undo', 'redo'],
-		'|',
-		['bold', 'underline', 'italic', 'strike', '|', 'subscript', 'superscript'],
-		'|',
-		['removeFormat'],
-		'|',
-		['outdent', 'indent'],
-		'|',
-		['fullScreen', 'showBlocks', 'codeView'],
-		'|',
-		['preview', 'print', 'copy']
-	],
-	height: 'auto'
+	// options
 });
 ```
 
@@ -117,20 +126,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>
 ```
@@ -155,15 +151,15 @@ 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'
-	}
+		uploadUrl: 'https://upload.image',
+	},
 });
 ```
 
-📘 [Learn how to build your own plugin →](https://suneditor.com/plugins)
+📘 [Learn how to build your own plugin →](https://suneditor.com/plugin-guide)
 
 🤖 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.
+See [Contribution Guide](./CONTRIBUTING.md#-ai-plugin-helper) for tips and examples.
 
 ---
 
@@ -175,6 +171,18 @@ See [Contribution Guide](./CONTRIBUTING.md#ai-plugin-helper) for tips and exampl
 
 ---
 
+## 💎 Sponsors
+
+### Backers
+
+[![Backers on Open Collective](https://opencollective.com/suneditor/backers.svg?width=890&avatarHeight=64&button=false)](https://opencollective.com/suneditor)
+
+### Sponsors
+
+[![Sponsors on Open Collective](https://opencollective.com/suneditor/sponsors.svg?width=890&avatarHeight=64&button=false)](https://opencollective.com/suneditor)
+
+---
+
 ## 📄 License
 
-SunEditor is an open-source project available under the [MIT License](./LICENSE).
+SunEditor is an open-source project available under the [MIT License](./LICENSE.txt).