suneditor 3.0.2 → 3.0.4

package/types/core/schema/frameContext.d.ts

@@ -37,6 +37,8 @@ import type {} from '../../typedef';
  * @property {HTMLElement} navigation - Navigation element (e.g., for outline or bookmarks).
  * @property {HTMLElement} charWrapper - Wrapper for the character counter element.
  * @property {HTMLElement} charCounter - Element showing the character counter.
+ * @property {HTMLElement} wordWrapper - Wrapper for the word counter element.
+ * @property {HTMLElement} wordCounter - Element showing the word counter.
  * @property {Window} [_ww] - The window object of the WYSIWYG frame (iframe window).
  * @property {Document} [_wd] - The document object of the WYSIWYG frame (iframe document).
  *
@@ -215,6 +217,14 @@ export type FrameContextStore = {
 	 * - Element showing the character counter.
 	 */
 	charCounter: HTMLElement;
+	/**
+	 * - Wrapper for the word counter element.
+	 */
+	wordWrapper: HTMLElement;
+	/**
+	 * - Element showing the word counter.
+	 */
+	wordCounter: HTMLElement;
 	/**
 	 * - The window object of the WYSIWYG frame (iframe window).
 	 */

package/types/core/schema/options.d.ts

@@ -105,6 +105,13 @@ export namespace DEFAULTS {
  * - `char`: Characters length.
  * - `byte`: Binary data size of characters.
  * - `byte-html`: Binary data size of the full HTML string.
+ *
+ * === Word Counter ===
+ * @property {boolean} [wordCounter=false] - Shows the number of words in the editor.
+ * @property {?string} [wordCounter_label=null] - Text to be displayed in the `wordCounter` area of the bottom bar.
+ * ```js
+ * { wordCounter_label: 'Words :' }
+ * ```
  */
 /** ================================================================================================================================ */
 /**
@@ -406,7 +413,22 @@ export namespace DEFAULTS {
  * @property {boolean} [tabDisable=false] - Disables tab key input.
  * @property {string} [toolbar_width="auto"] - Toolbar width.
  * @property {?HTMLElement} [toolbar_container] - Container element for the toolbar.
- * @property {number} [toolbar_sticky=0] - Enables sticky toolbar with optional offset.
+ * @property {number|{top: number, offset: number}} [toolbar_sticky=0] - Enables sticky toolbar.
+ * - `number`: Sets the sticky top position (px). Use `-1` to disable sticky.
+ * - `{top, offset}`: `top` is the sticky position when the page header is visible.
+ * - `offset` is the sticky position when a virtual keyboard shifts the viewport (e.g., on tablets, touch devices).
+ * - When the virtual keyboard is active, `offset` replaces `top` so the toolbar doesn't leave a gap
+ * - for a page header that has scrolled out of view. Default `offset` is `0`.
+ * ```js
+ * // Basic usage — sticky at top with 0px offset
+ * toolbar_sticky: 0
+ *
+ * // Account for a 92px fixed/sticky site header
+ * toolbar_sticky: 92
+ *
+ * // 92px header on desktop, but 0px when virtual keyboard pushes the viewport
+ * toolbar_sticky: { top: 92, offset: 0 }
+ * ```
  * @property {boolean} [toolbar_hide=false] - Hides toolbar initially.
  * @property {Object} [subToolbar={}] - Sub-toolbar configuration. A secondary toolbar that appears on text selection.
  * @property {SunEditor.UI.ButtonList} [subToolbar.buttonList] - List of Sub-toolbar buttons, grouped by sub-arrays.
@@ -714,8 +736,21 @@ export type EditorFrameOptions = {
 	 * - `char`: Characters length.
 	 * - `byte`: Binary data size of characters.
 	 * - `byte-html`: Binary data size of the full HTML string.
+	 *
+	 * === Word Counter ===
 	 */
 	charCounter_type?: 'char' | 'byte' | 'byte-html';
+	/**
+	 * - Shows the number of words in the editor.
+	 */
+	wordCounter?: boolean;
+	/**
+	 * - Text to be displayed in the `wordCounter` area of the bottom bar.
+	 * ```js
+	 * { wordCounter_label: 'Words :' }
+	 * ```
+	 */
+	wordCounter_label?: string | null;
 };
 export type OptionStyleResult = {
 	/**
@@ -1201,9 +1236,29 @@ export type EditorBaseOptions = {
 	 */
 	toolbar_container?: HTMLElement | null;
 	/**
-	 * - Enables sticky toolbar with optional offset.
+	 * - Enables sticky toolbar.
+	 * - `number`: Sets the sticky top position (px). Use `-1` to disable sticky.
+	 * - `{top, offset}`: `top` is the sticky position when the page header is visible.
+	 * - `offset` is the sticky position when a virtual keyboard shifts the viewport (e.g., on tablets, touch devices).
+	 * - When the virtual keyboard is active, `offset` replaces `top` so the toolbar doesn't leave a gap
+	 * - for a page header that has scrolled out of view. Default `offset` is `0`.
+	 * ```js
+	 * // Basic usage — sticky at top with 0px offset
+	 * toolbar_sticky: 0
+	 *
+	 * // Account for a 92px fixed/sticky site header
+	 * toolbar_sticky: 92
+	 *
+	 * // 92px header on desktop, but 0px when virtual keyboard pushes the viewport
+	 * toolbar_sticky: { top: 92, offset: 0 }
+	 * ```
 	 */
-	toolbar_sticky?: number;
+	toolbar_sticky?:
+		| number
+		| {
+				top: number;
+				offset: number;
+		  };
 	/**
 	 * - Hides toolbar initially.
 	 */
@@ -1513,7 +1568,18 @@ export type InternalBaseOptions = {
 };
 export type EditorInitOptions = EditorBaseOptions & PrivateBaseOptions & EditorFrameOptions;
 export type AllBaseOptions = EditorBaseOptions & PrivateBaseOptions & InternalBaseOptions;
-export type TransformedOptionKeys = 'formatClosureBrLine' | 'formatBrLine' | 'formatLine' | 'formatClosureBlock' | 'formatBlock' | 'toolbar_width' | 'toolbar_container' | 'toolbar_sticky' | 'strictMode' | 'lineAttrReset';
+export type TransformedOptionKeys =
+	| 'formatClosureBrLine'
+	| 'formatBrLine'
+	| 'formatLine'
+	| 'formatClosureBlock'
+	| 'formatBlock'
+	| 'toolbar_width'
+	| 'toolbar_container'
+	| '_toolbar_sticky'
+	| '_toolbar_sticky_offset'
+	| 'strictMode'
+	| 'lineAttrReset';
 export type StrictModeOptions = {
 	/**
 	 * - Filters disallowed HTML tags (`elementWhitelist`/`elementBlacklist`)
@@ -1563,7 +1629,8 @@ export type TransformedOptions = {
 	};
 	toolbar_width: string;
 	toolbar_container: HTMLElement | null;
-	toolbar_sticky: number;
+	_toolbar_sticky: number;
+	_toolbar_sticky_offset: number;
 	strictMode: StrictModeOptions;
 	lineAttrReset: string[];
 };

package/types/core/section/constructor.d.ts

@@ -42,7 +42,7 @@ export function InitOptions(
  * @description Create a context object for the editor frame.
  * @param {SunEditor.FrameOptions} targetOptions - `editor.frameOptions`
  * @param {HTMLElement} statusbar - statusbar element
- * @returns {{statusbar: HTMLElement, navigation: HTMLElement, charWrapper: HTMLElement, charCounter: HTMLElement}}
+ * @returns {{statusbar: HTMLElement, navigation: HTMLElement, charWrapper: HTMLElement, charCounter: HTMLElement, wordWrapper: HTMLElement, wordCounter: HTMLElement}}
  */
 export function CreateStatusbar(
 	targetOptions: SunEditor.FrameOptions,
@@ -52,6 +52,8 @@ export function CreateStatusbar(
 	navigation: HTMLElement;
 	charWrapper: HTMLElement;
 	charCounter: HTMLElement;
+	wordWrapper: HTMLElement;
+	wordCounter: HTMLElement;
 };
 /**
  * @description Update a button state, attributes, and icons