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

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

@@ -1,52 +1,17 @@
+import type {} from '../../typedef';
 export default DocumentType;
 /**
- * @constructor
  * @description DocumentType, page, header management class
- * @param {__se__EditorCore} editor - The root editor instance
- * @param {__se__FrameContext} fc - frame context object
  */
-declare function DocumentType(editor: __se__EditorCore, fc: __se__FrameContext): void;
 declare class DocumentType {
 	/**
 	 * @constructor
-	 * @description DocumentType, page, header management class
-	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {__se__FrameContext} fc - frame context object
-	 */
-	constructor(editor: __se__EditorCore, fc: __se__FrameContext);
-	editor: import('../editor').default;
-	context: __se__Context;
-	selection: import('../class/selection').default;
-	offset: import('../class/offset').default;
-	fc: __se__FrameContext;
-	ww: any;
-	wwFrame: any;
-	wwWidth: number;
-	wwHeight: number;
-	isAutoHeight: boolean;
-	displayPage: any;
-	innerHeaders: any;
-	_wwHeaders: any[];
-	documentTypeInner: any;
-	inner: any;
-	page: any;
-	totalPages: number;
-	pageNum: number;
-	pageHeight: number;
-	pageBreaksCnt: number;
-	pages: any[];
-	pages_line: any[];
-	prevScrollTop: number;
-	useHeader: any;
-	usePage: any;
-	navigatorButtons: any[];
-	pageNavigator: any;
-	_mirror: any;
-	_mirrorCache: number;
-	_positionCache: Map<any, any>;
-	_rePageTimeout: number;
-	_paddingTop: number;
-	_paddingBottom: number;
+	 * @param {SunEditor.Kernel} kernel
+	 * @param {SunEditor.FrameContext} fc - Frame context object
+	 */
+	constructor(kernel: SunEditor.Kernel, fc: SunEditor.FrameContext);
+	useHeader: boolean;
+	usePage: boolean;
 	/**
 	 * @description Refresh the document header area
 	 */
@@ -57,17 +22,28 @@ declare class DocumentType {
 	 * @returns {Promise<void>}
 	 */
 	rePage(force: boolean): Promise<void>;
+	_getDisplayPage(): SunEditor.EventWysiwyg;
+	/**
+	 * @internal
+	 * @description Calculates and compensates for the vertical gap between the rendered content (current page)
+	 * - and the mirrored preview page due to differences in width and layout.
+	 * @param {number} t - The initial top position value to be adjusted.
+	 * @param {HTMLCollection} chr - The elements array in the current (main) page.
+	 * @param {HTMLCollection} mChr - The elements array in the mirrored page.
+	 * @returns {number|null} The adjusted top value.
+	 */
+	_calcPageBreakTop(t: number, chr: HTMLCollection, mChr: HTMLCollection): number | null;
 	/**
-	 * @private
+	 * @internal
 	 * @description Initializes the cache for document elements.
-	 * @param {Array<HTMLElement>} mChr - List of mirrored elements.
+	 * @param {HTMLCollection} mChr - List of mirrored elements.
 	 */
-	_initializeCache(mChr: Array<HTMLElement>): void;
+	_initializeCache(mChr: HTMLCollection): void;
 	/**
-	 * @private
+	 * @internal
 	 * @description Retrieves the element at a given position.
 	 * @param {number} pageTop - The vertical position to check.
-	 * @param {NodeList} mChr - List of mirrored elements.
+	 * @param {HTMLCollection} mChr - List of mirrored elements.
 	 * @returns {{ci: number, cm: number, ch: number}} The closest element and its related data.
 	 * - ci: The index of the closest element.
 	 * - cm: The distance between the top of the closest element and the given position.
@@ -75,7 +51,7 @@ declare class DocumentType {
 	 */
 	_getElementAtPosition(
 		pageTop: number,
-		mChr: NodeList
+		mChr: HTMLCollection,
 	): {
 		ci: number;
 		cm: number;
@@ -113,7 +89,7 @@ declare class DocumentType {
 	pageGo(pageNum: number): void;
 	/**
 	 * @description Highlights the header of the current line.
-	 * @param {Node} line - The "line" element to be highlighted.
+	 * @param {Node} line - The `line` element to be highlighted.
 	 */
 	on(line: Node): void;
 	/**
@@ -121,58 +97,64 @@ declare class DocumentType {
 	 */
 	onChangeText(header: any): void;
 	/**
-	 * @private
+	 * @internal
 	 * @description Displays the current page number.
 	 */
 	_displayCurrentPage(): void;
 	/**
-	 * @private
+	 * @internal
 	 * @description Retrieves the scroll position in WYSIWYG mode.
 	 * @returns {number} The current scroll position.
 	 */
 	_getWWScrollTop(): number;
 	/**
-	 * @private
+	 * @internal
 	 * @description Moves to a specific page and updates the view.
 	 * @param {number} pageNum - The target page number.
 	 */
 	_movePage(pageNum: number, force: any): void;
 	/**
-	 * @private
+	 * @internal
 	 * @description Applies smooth scrolling for page navigation.
 	 */
 	_applyPageScroll(top: any, callback: any): void;
 	/**
-	 * @private
+	 * @internal
 	 * @description Retrieves the global top offset of an element.
 	 * @returns {number} The top offset of the element.
 	 */
 	_getGlobalTop(): number;
 	/**
-	 * @private
+	 * @internal
 	 * @description Finds an header element of innerHeaders element.
 	 * @param {Node} header - H tag element to find.
 	 * @returns {HTMLElement|null} The found element, or null if not found.
 	 */
 	_findItem(header: Node): HTMLElement | null;
 	/**
-	 * @private
+	 * @internal
 	 * @description Finds the closest header element from a given line.
-	 * @param {Node} line - The "line" to check.
+	 * @param {Node} line - The `line` to check.
 	 * @returns {Node|null} The closest header element, or null if not found.
 	 */
 	_findLinesHeader(line: Node): Node | null;
 	/**
-	 * @private
+	 * @internal
 	 * @description Checks if an element is a header.
 	 * @param {Node} element - The element to check.
 	 * @returns {boolean} True if the element is a header, otherwise false.
 	 */
 	_is(element: Node): boolean;
 	/**
-	 * @private
+	 * @internal
 	 * @description Retrieves all headers in the document.
-	 * @returns {Array<HTMLElement>} An array of header elements.
+	 * @returns {NodeListOf<Element>} An array of header elements.
+	 */
+	_getHeaders(): NodeListOf<Element>;
+	/**
+	 * @internal
+	 * @description Destroy the DocumentType instance and release memory
 	 */
-	_getHeaders(): Array<HTMLElement>;
+	_destroy(): void;
+	#private;
 }