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

package/types/core/class/offset.d.ts

@@ -1,522 +0,0 @@
-export default Offset;
-export type OffsetThis = Omit<Offset & Partial<__se__EditorInjector>, 'offset'>;
-/**
- * Bounding rectangle information of the selection range.
- */
-export type RectsInfo = {
-	/**
-	 * - The left position of the selection.
-	 */
-	left: number;
-	/**
-	 * - The right position of the selection.
-	 */
-	right: number;
-	/**
-	 * - The top position of the selection.
-	 */
-	top: number;
-	/**
-	 * - The bottom position of the selection.
-	 */
-	bottom: number;
-	/**
-	 * - Whether the selection contains text.
-	 */
-	noText?: boolean;
-	/**
-	 * - The width of the selection.
-	 */
-	width?: number;
-	/**
-	 * - The height of the selection.
-	 */
-	height?: number;
-};
-export type OffsetInfo = {
-	/**
-	 * - The top position of the node relative to the entire document, including iframe offsets.
-	 */
-	top: number;
-	/**
-	 * - The left position of the node relative to the entire document, including iframe offsets.
-	 */
-	left: number;
-};
-export type OffsetLocalInfo = {
-	/**
-	 * - The top position of the node relative to the WYSIWYG editor.
-	 */
-	top: number;
-	/**
-	 * - The left position of the node relative to the WYSIWYG editor.
-	 */
-	left: number;
-	/**
-	 * - The right position of the node relative to the WYSIWYG editor.
-	 */
-	right: number;
-	/**
-	 * - The horizontal scroll offset inside the WYSIWYG editor.
-	 */
-	scrollX: number;
-	/**
-	 * - The vertical scroll offset inside the WYSIWYG editor.
-	 */
-	scrollY: number;
-};
-export type OffsetGlobalInfo = {
-	/**
-	 * - The top position of the element relative to the entire document.
-	 */
-	top: number;
-	/**
-	 * - The left position of the element relative to the entire document.
-	 */
-	left: number;
-	/**
-	 * - The total width of the element, including its content, padding, and border.
-	 */
-	width: number;
-	/**
-	 * - The total height of the element, including its content, padding, and border.
-	 */
-	height: number;
-	/**
-	 * - The amount of vertical scrolling applied to the element.
-	 */
-	scrollTop: number;
-	/**
-	 * - The amount of horizontal scrolling applied to the element.
-	 */
-	scrollLeft: number;
-};
-export type OffsetGlobalScrollInfo = {
-	/**
-	 * - Total top scroll distance
-	 */
-	top: number;
-	/**
-	 * - Total left scroll distance
-	 */
-	left: number;
-	/**
-	 * - Total width including scrollable area
-	 */
-	width: number;
-	/**
-	 * - Total height including scrollable area
-	 */
-	height: number;
-	/**
-	 * - Horizontal offset from the top reference element
-	 */
-	x: number;
-	/**
-	 * - Vertical offset from the top reference element
-	 */
-	y: number;
-	/**
-	 * - Element or window used as the vertical scroll reference
-	 */
-	ohOffsetEl: HTMLElement | Window | null;
-	/**
-	 * - Element or window used as the horizontal scroll reference
-	 */
-	owOffsetEl: HTMLElement | Window | null;
-	/**
-	 * - Height of the vertical scrollable area (clientHeight)
-	 */
-	oh: number;
-	/**
-	 * - Width of the horizontal scrollable area (clientWidth)
-	 */
-	ow: number;
-	/**
-	 * - Indicates if the vertical scroll reference is the editor area
-	 */
-	heightEditorRefer: boolean;
-	/**
-	 * - Indicates if the horizontal scroll reference is the editor area
-	 */
-	widthEditorRefer: boolean;
-	/**
-	 * - Top position of the height offset element relative to the viewport
-	 */
-	ts: number;
-	/**
-	 * - Left position of the width offset element relative to the viewport
-	 */
-	ls: number;
-};
-export type OffsetWWScrollInfo = {
-	/**
-	 * - The top scroll offset inside the WYSIWYG editor.
-	 */
-	top: number;
-	/**
-	 * - The left scroll offset inside the WYSIWYG editor.
-	 */
-	left: number;
-	/**
-	 * - The total width of the WYSIWYG editor's scrollable area.
-	 */
-	width: number;
-	/**
-	 * - The total height of the WYSIWYG editor's scrollable area.
-	 */
-	height: number;
-	/**
-	 * - The sum of `top` and `height`, representing the bottom-most scrollable position.
-	 */
-	bottom: number;
-	/**
-	 * - The bounding rectangle of the editor's visible area.
-	 */
-	rects: RectsInfo;
-};
-/**
- * @typedef {Omit<Offset & Partial<__se__EditorInjector>, 'offset'>} OffsetThis
- */
-/**
- * @typedef {Object} RectsInfo Bounding rectangle information of the selection range.
- * @property {number} rects.left - The left position of the selection.
- * @property {number} rects.right - The right position of the selection.
- * @property {number} rects.top - The top position of the selection.
- * @property {number} rects.bottom - The bottom position of the selection.
- * @property {boolean} [rects.noText] - Whether the selection contains text.
- * @property {number} [rects.width] - The width of the selection.
- * @property {number} [rects.height] - The height of the selection.
- */
-/**
- * @typedef {Object} OffsetInfo
- * @property {number} top - The top position of the node relative to the entire document, including iframe offsets.
- * @property {number} left - The left position of the node relative to the entire document, including iframe offsets.
- */
-/**
- * @typedef {Object} OffsetLocalInfo
- * @property {number} top - The top position of the node relative to the WYSIWYG editor.
- * @property {number} left - The left position of the node relative to the WYSIWYG editor.
- * @property {number} right - The right position of the node relative to the WYSIWYG editor.
- * @property {number} scrollX - The horizontal scroll offset inside the WYSIWYG editor.
- * @property {number} scrollY - The vertical scroll offset inside the WYSIWYG editor.
- */
-/**
- * @typedef {Object} OffsetGlobalInfo
- * @property {number} top - The top position of the element relative to the entire document.
- * @property {number} left - The left position of the element relative to the entire document.
- * @property {number} width - The total width of the element, including its content, padding, and border.
- * @property {number} height - The total height of the element, including its content, padding, and border.
- * @property {number} scrollTop - The amount of vertical scrolling applied to the element.
- * @property {number} scrollLeft - The amount of horizontal scrolling applied to the element.
- */
-/**
- * @typedef {Object} OffsetGlobalScrollInfo
- * @property {number} top - Total top scroll distance
- * @property {number} left - Total left scroll distance
- * @property {number} width - Total width including scrollable area
- * @property {number} height - Total height including scrollable area
- * @property {number} x - Horizontal offset from the top reference element
- * @property {number} y - Vertical offset from the top reference element
- * @property {HTMLElement|Window|null} ohOffsetEl - Element or window used as the vertical scroll reference
- * @property {HTMLElement|Window|null} owOffsetEl - Element or window used as the horizontal scroll reference
- * @property {number} oh - Height of the vertical scrollable area (clientHeight)
- * @property {number} ow - Width of the horizontal scrollable area (clientWidth)
- * @property {boolean} heightEditorRefer - Indicates if the vertical scroll reference is the editor area
- * @property {boolean} widthEditorRefer - Indicates if the horizontal scroll reference is the editor area
- * @property {number} ts - Top position of the height offset element relative to the viewport
- * @property {number} ls - Left position of the width offset element relative to the viewport
- */
-/**
- * @typedef {Object} OffsetWWScrollInfo
- * @property {number} top - The top scroll offset inside the WYSIWYG editor.
- * @property {number} left - The left scroll offset inside the WYSIWYG editor.
- * @property {number} width - The total width of the WYSIWYG editor's scrollable area.
- * @property {number} height - The total height of the WYSIWYG editor's scrollable area.
- * @property {number} bottom - The sum of `top` and `height`, representing the bottom-most scrollable position.
- * @property {RectsInfo} rects - The bounding rectangle of the editor's visible area.
- */
-/**
- * @constructor
- * @this {OffsetThis}
- * @description Offset class, get the position of the element
- * @param {__se__EditorCore} editor - The root editor instance
- */
-declare function Offset(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, editor: __se__EditorCore): void;
-declare class Offset {
-	/**
-	 * @typedef {Omit<Offset & Partial<__se__EditorInjector>, 'offset'>} OffsetThis
-	 */
-	/**
-	 * @typedef {Object} RectsInfo Bounding rectangle information of the selection range.
-	 * @property {number} rects.left - The left position of the selection.
-	 * @property {number} rects.right - The right position of the selection.
-	 * @property {number} rects.top - The top position of the selection.
-	 * @property {number} rects.bottom - The bottom position of the selection.
-	 * @property {boolean} [rects.noText] - Whether the selection contains text.
-	 * @property {number} [rects.width] - The width of the selection.
-	 * @property {number} [rects.height] - The height of the selection.
-	 */
-	/**
-	 * @typedef {Object} OffsetInfo
-	 * @property {number} top - The top position of the node relative to the entire document, including iframe offsets.
-	 * @property {number} left - The left position of the node relative to the entire document, including iframe offsets.
-	 */
-	/**
-	 * @typedef {Object} OffsetLocalInfo
-	 * @property {number} top - The top position of the node relative to the WYSIWYG editor.
-	 * @property {number} left - The left position of the node relative to the WYSIWYG editor.
-	 * @property {number} right - The right position of the node relative to the WYSIWYG editor.
-	 * @property {number} scrollX - The horizontal scroll offset inside the WYSIWYG editor.
-	 * @property {number} scrollY - The vertical scroll offset inside the WYSIWYG editor.
-	 */
-	/**
-	 * @typedef {Object} OffsetGlobalInfo
-	 * @property {number} top - The top position of the element relative to the entire document.
-	 * @property {number} left - The left position of the element relative to the entire document.
-	 * @property {number} width - The total width of the element, including its content, padding, and border.
-	 * @property {number} height - The total height of the element, including its content, padding, and border.
-	 * @property {number} scrollTop - The amount of vertical scrolling applied to the element.
-	 * @property {number} scrollLeft - The amount of horizontal scrolling applied to the element.
-	 */
-	/**
-	 * @typedef {Object} OffsetGlobalScrollInfo
-	 * @property {number} top - Total top scroll distance
-	 * @property {number} left - Total left scroll distance
-	 * @property {number} width - Total width including scrollable area
-	 * @property {number} height - Total height including scrollable area
-	 * @property {number} x - Horizontal offset from the top reference element
-	 * @property {number} y - Vertical offset from the top reference element
-	 * @property {HTMLElement|Window|null} ohOffsetEl - Element or window used as the vertical scroll reference
-	 * @property {HTMLElement|Window|null} owOffsetEl - Element or window used as the horizontal scroll reference
-	 * @property {number} oh - Height of the vertical scrollable area (clientHeight)
-	 * @property {number} ow - Width of the horizontal scrollable area (clientWidth)
-	 * @property {boolean} heightEditorRefer - Indicates if the vertical scroll reference is the editor area
-	 * @property {boolean} widthEditorRefer - Indicates if the horizontal scroll reference is the editor area
-	 * @property {number} ts - Top position of the height offset element relative to the viewport
-	 * @property {number} ls - Left position of the width offset element relative to the viewport
-	 */
-	/**
-	 * @typedef {Object} OffsetWWScrollInfo
-	 * @property {number} top - The top scroll offset inside the WYSIWYG editor.
-	 * @property {number} left - The left scroll offset inside the WYSIWYG editor.
-	 * @property {number} width - The total width of the WYSIWYG editor's scrollable area.
-	 * @property {number} height - The total height of the WYSIWYG editor's scrollable area.
-	 * @property {number} bottom - The sum of `top` and `height`, representing the bottom-most scrollable position.
-	 * @property {RectsInfo} rects - The bounding rectangle of the editor's visible area.
-	 */
-	/**
-	 * @constructor
-	 * @this {OffsetThis}
-	 * @description Offset class, get the position of the element
-	 * @param {__se__EditorCore} editor - The root editor instance
-	 */
-	constructor(editor: __se__EditorCore);
-	_scrollEvent: any;
-	_elTop: number;
-	_scrollY: number;
-	_isFixed: boolean;
-	/**
-	 * @this {OffsetThis}
-	 * @description Gets the position just outside the argument's internal editor (wysiwygFrame).
-	 * @param {Node} node Target node.
-	 * @returns {OffsetInfo} Position relative to the editor frame.
-	 */
-	get(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, node: Node): OffsetInfo;
-	/**
-	 * @this {OffsetThis}
-	 * @description Gets the position inside the internal editor of the argument.
-	 * @param {Node} node Target node.
-	 * @returns {OffsetLocalInfo} Position relative to the WYSIWYG editor.
-	 */
-	getLocal(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, node: Node): OffsetLocalInfo;
-	/**
-	 * @this {OffsetThis}
-	 * @description Returns the position of the argument relative to the global document.
-	 * @param {?Node=} node Target element.
-	 * @returns {OffsetGlobalInfo} Global position and scroll values.
-	 */
-	getGlobal(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, node?: (Node | null) | undefined): OffsetGlobalInfo;
-	/**
-	 * @this {OffsetThis}
-	 * @description Gets the current editor-relative scroll offset.
-	 * @param {?Node=} node Target element.
-	 * @returns {OffsetGlobalScrollInfo} Global scroll information.
-	 */
-	getGlobalScroll(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, node?: (Node | null) | undefined): OffsetGlobalScrollInfo;
-	/**
-	 * @this {OffsetThis}
-	 * @description Get the scroll info of the WYSIWYG area.
-	 * @returns {OffsetWWScrollInfo} Scroll information within the editor.
-	 */
-	getWWScroll(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>): OffsetWWScrollInfo;
-	/**
-	 * @this {OffsetThis}
-	 * @description Sets the relative position of an element
-	 * @param {HTMLElement} element Element to position
-	 * @param {HTMLElement} e_container Element's root container
-	 * @param {HTMLElement} target Target element to position against
-	 * @param {HTMLElement} t_container Target's root container
-	 * @param {boolean} _reload Whether to reload position
-	 */
-	setRelPosition(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, element: HTMLElement, e_container: HTMLElement, target: HTMLElement, t_container: HTMLElement, _reload: boolean): void;
-	/**
-	 * @this {OffsetThis}
-	 * @description Sets the absolute position of an element
-	 * @param {HTMLElement} element Element to position
-	 * @param {HTMLElement} target Target element
-	 * @param {Object} params Position parameters
-	 * @param {boolean} [params.isWWTarget=false] Whether the target is within the editor's WYSIWYG area
-	 * @param {{left:number, top:number}} [params.addOffset={left:0, top:0}] Additional offset
-	 * @param {"bottom"|"top"} [params.position="bottom"] Position ('bottom'|'top')
-	 * @param {*} params.inst Instance object of caller
-	 * @returns {{position: "top" | "bottom"} | undefined} Success -> {position: current position}
-	 */
-	setAbsPosition(
-		this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>,
-		element: HTMLElement,
-		target: HTMLElement,
-		params: {
-			isWWTarget?: boolean;
-			addOffset?: {
-				left: number;
-				top: number;
-			};
-			position?: 'bottom' | 'top';
-			inst: any;
-		}
-	):
-		| {
-				position: 'top' | 'bottom';
-		  }
-		| undefined;
-	/**
-	 * @this {OffsetThis}
-	 * @description Sets the position of an element relative to a range
-	 * @param {HTMLElement} element Element to position
-	 * @param {?Range} range Range to position against.
-	 * - if null, the current selection range is used
-	 * @param {Object} [options={}] Position options
-	 * @param {"bottom"|"top"} [options.position="bottom"] Position ('bottom'|'top')
-	 * @param {number} [options.addTop=0] Additional top offset
-	 * @returns {boolean} Success / Failure
-	 */
-	setRangePosition(
-		this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>,
-		element: HTMLElement,
-		range: Range | null,
-		{
-			position,
-			addTop
-		}?: {
-			position?: 'bottom' | 'top';
-			addTop?: number;
-		}
-	): boolean;
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Sets the position of an element relative to the selection range in the editor.
-	 * - This method calculates the top and left offsets for the element, ensuring it
-	 * - does not overflow the editor boundaries and adjusts the arrow positioning accordingly.
-	 * @param {boolean} isDirTop - Determines whether the element should be positioned above (`true`) or below (`false`) the target.
-	 * @param {RectsInfo} rects - Bounding rectangle information of the selection range.
-	 * @param {HTMLElement} element - The element to be positioned.
-	 * @param {number} editorLeft - The left position of the editor.
-	 * @param {number} editorWidth - The width of the editor.
-	 * @param {number} scrollLeft - The horizontal scroll offset.
-	 * @param {number} scrollTop - The vertical scroll offset.
-	 * @param {number} [addTop=0] - Additional top margin adjustment.
-	 */
-	_setOffsetOnRange(
-		this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>,
-		isDirTop: boolean,
-		rects: RectsInfo,
-		element: HTMLElement,
-		editorLeft: number,
-		editorWidth: number,
-		scrollLeft: number,
-		scrollTop: number,
-		addTop?: number
-	): void;
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Get available space from page bottom
-	 * @returns {number} Available space
-	 */
-	_getPageBottomSpace(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>): number;
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Calculates the vertical margin offsets for the target element relative to the editor frame.
-	 * - This method determines the top and bottom margins based on various conditions such as
-	 * - fullscreen mode, iframe usage, toolbar height, and scroll positions.
-	 * @param {number} tmtw Top margin to window
-	 * @param {number} tmbw Bottom margin to window
-	 * @param {number} toolbarH Toolbar height
-	 * @param {{w: number, h: number}} clientSize documentElement.clientWidth, documentElement.clientHeight
-	 * @param {RectsInfo} targetRect Target rect object
-	 * @param {boolean} isTargetAbs Is target absolute position
-	 * @param {OffsetWWScrollInfo} wwScroll WYSIWYG scroll info
-	 * @returns {{rmt:number, rmb:number, rt:number}} Margin values (rmt: top margin, rmb: bottom margin, rt: Toolbar height offset adjustment)
-	 */
-	_getVMargin(
-		this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>,
-		tmtw: number,
-		tmbw: number,
-		toolbarH: number,
-		clientSize: {
-			w: number;
-			h: number;
-		},
-		targetRect: RectsInfo,
-		isTargetAbs: boolean,
-		wwScroll: OffsetWWScrollInfo
-	): {
-		rmt: number;
-		rmb: number;
-		rt: number;
-	};
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Sets the visibility and direction of the arrow element.
-	 * - This method applies the appropriate class (`se-arrow-up` or `se-arrow-down`)
-	 * - based on the specified direction key and adjusts the visibility of the arrow.
-	 * @param {HTMLElement} arrow - The arrow element to be updated.
-	 * @param {string} key - The direction of the arrow. ("up"|"down"|"")
-	 * - Accepts `'up'` for an upward arrow, `'down'` for a downward arrow,
-	 * - or any other value to hide the arrow.
-	 */
-	_setArrow(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>, arrow: HTMLElement, key: string): void;
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Retrieves the current window scroll position and viewport size.
-	 * - Returns an object containing the scroll offsets, viewport dimensions, and boundary rects.
-	 * @returns {{
-	 *   top: number,
-	 *   left: number,
-	 *   width: number,
-	 *   height: number,
-	 *   bottom: number,
-	 *   rects: RectsInfo
-	 * }} An object with scroll and viewport information.
-	 */
-	_getWindowScroll(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>): {
-		top: number;
-		left: number;
-		width: number;
-		height: number;
-		bottom: number;
-		rects: RectsInfo;
-	};
-	/**
-	 * @private
-	 * @this {OffsetThis}
-	 * @description Removes the global scroll event listener from the editor.
-	 * - Resets related scroll tracking properties.
-	 */
-	__removeGlobalEvent(this: Omit<Offset & Partial<import('../../editorInjector').default>, 'offset'>): void;
-}