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

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

@@ -0,0 +1,45 @@
+/**
+ * @description Elements and variables you should have
+ * @param {{target: Element, key: *, options: __se__FrameOptions}} editorTarget Target textarea
+ * @param {HTMLElement} top Editor top area
+ * @param {HTMLElement} wwFrame Editor wysiwyg frame
+ * @param {HTMLElement} codeWrapper Editor code view wrapper
+ * @param {HTMLElement} codeFrame Editor code view frame
+ * @param {{inner: HTMLElement, page: HTMLElement, pageMirror: HTMLElement}} documentTypeInner Document type elements
+ * @param {?HTMLElement} statusbar Editor statusbar
+ * @param {*} key root key
+ * @returns {__se__FrameContext}
+ */
+export function CreateFrameContext(
+	editorTarget: {
+		target: Element;
+		key: any;
+		options: __se__FrameOptions;
+	},
+	top: HTMLElement,
+	wwFrame: HTMLElement,
+	codeWrapper: HTMLElement,
+	codeFrame: HTMLElement,
+	statusbar: HTMLElement | null,
+	documentTypeInner: {
+		inner: HTMLElement;
+		page: HTMLElement;
+		pageMirror: HTMLElement;
+	},
+	key: any
+): __se__FrameContext;
+/**
+ * @description Update statusbar context
+ * @param {HTMLElement} statusbar Statusbar element
+ * @param {__se__FrameContext} mapper FrameContext map
+ */
+export function UpdateStatusbarContext(statusbar: HTMLElement, mapper: __se__FrameContext): void;
+/**
+ * @description Common elements and variables you should have
+ * @param {HTMLElement} toolbar Toolbar frame
+ * @param {HTMLElement|null} toolbarContainer Toolbar container
+ * @param {HTMLElement} menuTray menu tray
+ * @param {HTMLElement|null} subbar sub toolbar
+ * @returns {__se__Context}
+ */
+export function CreateContext(toolbar: HTMLElement, toolbarContainer: HTMLElement | null, menuTray: HTMLElement, subbar: HTMLElement | null, statusbarContainer: any): __se__Context;

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

@@ -0,0 +1,178 @@
+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;
+	/**
+	 * @description Refresh the document header area
+	 */
+	reHeader(): void;
+	/**
+	 * @description Refresh the document page
+	 * @param {boolean} force - Whether to force the page to be re-rendered
+	 * @returns {Promise<void>}
+	 */
+	rePage(force: boolean): Promise<void>;
+	/**
+	 * @private
+	 * @description Initializes the cache for document elements.
+	 * @param {Array<HTMLElement>} mChr - List of mirrored elements.
+	 */
+	_initializeCache(mChr: Array<HTMLElement>): void;
+	/**
+	 * @private
+	 * @description Retrieves the element at a given position.
+	 * @param {number} pageTop - The vertical position to check.
+	 * @param {NodeList} 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.
+	 * - ch: The height of the closest element.
+	 */
+	_getElementAtPosition(
+		pageTop: number,
+		mChr: NodeList
+	): {
+		ci: number;
+		cm: number;
+		ch: number;
+	};
+	/**
+	 * @description Resizes the document page dynamically.
+	 */
+	resizePage(): void;
+	/**
+	 * @description Scrolls the document page.
+	 */
+	scrollPage(): void;
+	/**
+	 * @description Scrolls the window to a specific position.
+	 */
+	scrollWindow(): void;
+	/**
+	 * @description Retrieves the current page number.
+	 * @returns {number} The current page number.
+	 */
+	getCurrentPageNumber(): number;
+	/**
+	 * @description Moves to the previous page.
+	 */
+	pageUp(): void;
+	/**
+	 * @description Moves to the next page.
+	 */
+	pageDown(): void;
+	/**
+	 * @description Moves to a specific page.
+	 * @param {number} pageNum - The target page number.
+	 */
+	pageGo(pageNum: number): void;
+	/**
+	 * @description Highlights the header of the current line.
+	 * @param {Node} line - The "line" element to be highlighted.
+	 */
+	on(line: Node): void;
+	/**
+	 * @description Handles text changes in the document.
+	 */
+	onChangeText(header: any): void;
+	/**
+	 * @private
+	 * @description Displays the current page number.
+	 */
+	_displayCurrentPage(): void;
+	/**
+	 * @private
+	 * @description Retrieves the scroll position in WYSIWYG mode.
+	 * @returns {number} The current scroll position.
+	 */
+	_getWWScrollTop(): number;
+	/**
+	 * @private
+	 * @description Moves to a specific page and updates the view.
+	 * @param {number} pageNum - The target page number.
+	 */
+	_movePage(pageNum: number, force: any): void;
+	/**
+	 * @private
+	 * @description Applies smooth scrolling for page navigation.
+	 */
+	_applyPageScroll(top: any, callback: any): void;
+	/**
+	 * @private
+	 * @description Retrieves the global top offset of an element.
+	 * @returns {number} The top offset of the element.
+	 */
+	_getGlobalTop(): number;
+	/**
+	 * @private
+	 * @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
+	 * @description Finds the closest header element from a given line.
+	 * @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
+	 * @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
+	 * @description Retrieves all headers in the document.
+	 * @returns {Array<HTMLElement>} An array of header elements.
+	 */
+	_getHeaders(): Array<HTMLElement>;
+}

package/types/editorInjector/_classes.d.ts

@@ -0,0 +1,41 @@
+export default ClassInjector;
+/**
+ * @private
+ * @description Add all inner classes to the editor instance.
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+declare function ClassInjector(editor: __se__EditorCore): void;
+declare class ClassInjector {
+	/**
+	 * @private
+	 * @description Add all inner classes to the editor instance.
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 */
+	private constructor();
+	/** @description Toolbar class instance @type {__se__EditorCore['toolbar']} */
+	toolbar: __se__EditorCore['toolbar'];
+	/** @description Sub-Toolbar class instance @type {__se__EditorCore['subToolbar']|null} */
+	subToolbar: __se__EditorCore['subToolbar'] | null;
+	/** @description Char class instance @type {__se__EditorCore['char']} */
+	char: __se__EditorCore['char'];
+	/** @description Component class instance @type {__se__EditorCore['component']} */
+	component: __se__EditorCore['component'];
+	/** @description Format class instance @type {__se__EditorCore['format']} */
+	format: __se__EditorCore['format'];
+	/** @description HTML class instance @type {__se__EditorCore['html']} */
+	html: __se__EditorCore['html'];
+	/** @description Menu class instance @type {__se__EditorCore['menu']} */
+	menu: __se__EditorCore['menu'];
+	/** @description NodeTransform class instance @type {__se__EditorCore['nodeTransform']} */
+	nodeTransform: __se__EditorCore['nodeTransform'];
+	/** @description Offset class instance @type {__se__EditorCore['offset']} */
+	offset: __se__EditorCore['offset'];
+	/** @description Selection class instance @type {__se__EditorCore['selection']} */
+	selection: __se__EditorCore['selection'];
+	/** @description Shortcuts class instance @type {__se__EditorCore['shortcuts']} */
+	shortcuts: __se__EditorCore['shortcuts'];
+	/** @description UI class instance @type {__se__EditorCore['ui']} */
+	ui: __se__EditorCore['ui'];
+	/** @description Viewer class instance @type {__se__EditorCore['viewer']} */
+	viewer: __se__EditorCore['viewer'];
+}

package/types/editorInjector/_core.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @description Add default properties to the editor core object.
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+export default function CoreInjector(editor: __se__EditorCore): void;
+export default class CoreInjector {
+	/**
+	 * @description Add default properties to the editor core object.
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 */
+	constructor(editor: __se__EditorCore);
+	/**
+	 * @description The root editor instance.
+	 * @type {__se__EditorCore}
+	 */
+	editor: __se__EditorCore;
+	/**
+	 * @description The event manager instance.
+	 * @type {__se__EditorCore['eventManager']}
+	 */
+	eventManager: __se__EditorCore['eventManager'];
+	/**
+	 * @description The history manager instance.
+	 * @type {__se__EditorCore['history']}
+	 */
+	history: __se__EditorCore['history'];
+	/**
+	 * @description The events instance.
+	 * @type {__se__EditorCore['events']}
+	 */
+	events: __se__EditorCore['events'];
+	/**
+	 * @description The function to trigger an event.
+	 * @type {__se__EditorCore['triggerEvent']}
+	 */
+	triggerEvent: __se__EditorCore['triggerEvent'];
+	/**
+	 * @description The wrapper element for carrying elements.
+	 * @type {__se__EditorCore['carrierWrapper']}
+	 */
+	carrierWrapper: __se__EditorCore['carrierWrapper'];
+	/**
+	 * @description The plugins used by the editor.
+	 * @type {__se__EditorCore['plugins']}
+	 */
+	plugins: __se__EditorCore['plugins'];
+	/**
+	 * @description The status of the editor.
+	 * @type {__se__EditorStatus}
+	 */
+	status: __se__EditorStatus;
+	/**
+	 * @description The editor's context map.
+	 * @type {__se__EditorCore['context']}
+	 */
+	context: __se__EditorCore['context'];
+	/**
+	 * @description The editor's options map.
+	 * @type {__se__EditorCore['options']}
+	 */
+	options: __se__EditorCore['options'];
+	/**
+	 * @description The editor's icons.
+	 * @type {__se__EditorCore['icons']}
+	 */
+	icons: __se__EditorCore['icons'];
+	/**
+	 * @description The language settings.
+	 * @type {__se__EditorCore['lang']}
+	 */
+	lang: __se__EditorCore['lang'];
+	/**
+	 * @description editor.frameRoots map.
+	 * @type {__se__EditorCore['frameRoots']}
+	 */
+	frameRoots: __se__EditorCore['frameRoots'];
+	/**
+	 * @description The window object.
+	 * @type {Window}
+	 */
+	_w: Window;
+	/**
+	 * @description The document object.
+	 * @type {Document}
+	 */
+	_d: Document;
+	/**
+	 * @description The shadow root object (if any).
+	 * @type {__se__EditorCore['_shadowRoot']}
+	 */
+	_shadowRoot: __se__EditorCore['_shadowRoot'];
+}

package/types/editorInjector/index.d.ts

@@ -0,0 +1,71 @@
+export default EditorInjector;
+/**
+ * @description Initializes and adds inner classes and default properties of the editor.
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+declare function EditorInjector(editor: __se__EditorCore): void;
+declare class EditorInjector {
+	/**
+	 * @description Initializes and adds inner classes and default properties of the editor.
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 */
+	constructor(editor: __se__EditorCore);
+	/** @type {__se__EditorCore} */
+	editor: __se__EditorCore;
+	/** @type {import('./_core').default['eventManager']} */
+	eventManager: import('./_core').default['eventManager'];
+	/** @type {import('./_core').default['history']} */
+	history: import('./_core').default['history'];
+	/** @type {import('./_core').default['events']} */
+	events: import('./_core').default['events'];
+	/** @type {import('./_core').default['triggerEvent']} */
+	triggerEvent: import('./_core').default['triggerEvent'];
+	/** @type {import('./_core').default['carrierWrapper']} */
+	carrierWrapper: import('./_core').default['carrierWrapper'];
+	/** @type {import('./_core').default['plugins']} */
+	plugins: import('./_core').default['plugins'];
+	/** @type {import('./_core').default['status']} */
+	status: import('./_core').default['status'];
+	/** @type {import('./_core').default['context']} */
+	context: import('./_core').default['context'];
+	/** @type {import('./_core').default['options']} */
+	options: import('./_core').default['options'];
+	/** @type {import('./_core').default['icons']} */
+	icons: import('./_core').default['icons'];
+	/** @type {import('./_core').default['lang']} */
+	lang: import('./_core').default['lang'];
+	/** @type {import('./_core').default['frameRoots']} */
+	frameRoots: import('./_core').default['frameRoots'];
+	/** @type {import('./_core').default['_w']} */
+	_w: import('./_core').default['_w'];
+	/** @type {import('./_core').default['_d']} */
+	_d: import('./_core').default['_d'];
+	/** @type {import('./_core').default['_shadowRoot']} */
+	_shadowRoot: import('./_core').default['_shadowRoot'];
+	/** @type {import('./_classes').default['toolbar']} */
+	toolbar: import('./_classes').default['toolbar'];
+	/** @type {import('./_classes').default['subToolbar']} */
+	subToolbar: import('./_classes').default['subToolbar'];
+	/** @type {import('./_classes').default['char']} */
+	char: import('./_classes').default['char'];
+	/** @type {import('./_classes').default['component']} */
+	component: import('./_classes').default['component'];
+	/** @type {import('./_classes').default['format']} */
+	format: import('./_classes').default['format'];
+	/** @type {import('./_classes').default['html']} */
+	html: import('./_classes').default['html'];
+	/** @type {import('./_classes').default['menu']} */
+	menu: import('./_classes').default['menu'];
+	/** @type {import('./_classes').default['nodeTransform']} */
+	nodeTransform: import('./_classes').default['nodeTransform'];
+	/** @type {import('./_classes').default['offset']} */
+	offset: import('./_classes').default['offset'];
+	/** @type {import('./_classes').default['selection']} */
+	selection: import('./_classes').default['selection'];
+	/** @type {import('./_classes').default['shortcuts']} */
+	shortcuts: import('./_classes').default['shortcuts'];
+	/** @type {import('./_classes').default['ui']} */
+	ui: import('./_classes').default['ui'];
+	/** @type {import('./_classes').default['viewer']} */
+	viewer: import('./_classes').default['viewer'];
+}

package/types/events.d.ts

@@ -0,0 +1,273 @@
+declare namespace _default {
+	let onload: any;
+	let onScroll: any;
+	let onMouseDown: any;
+	let onClick: any;
+	let onInput: any;
+	let onMouseLeave: any;
+	let onKeyDown: any;
+	let onKeyUp: any;
+	let onFocus: any;
+	let onBlur: any;
+	let onCopy: any;
+	let onCut: any;
+	let onChange: any;
+	let onShowToolbar: any;
+	let onShowController: any;
+	let onBeforeShowController: any;
+	let onToggleCodeView: any;
+	let onToggleFullScreen: any;
+	let onResizeEditor: any;
+	let onSetToolbarButtons: any;
+	let onSave: any;
+	let onDrop: any;
+	let onPaste: any;
+	let imageUploadHandler: any;
+	let onImageUploadBefore: any;
+	let onImageLoad: any;
+	let onImageAction: any;
+	let onImageUploadError: any;
+	let onImageDeleteBefore: any;
+	let videoUploadHandler: any;
+	let onVideoUploadBefore: any;
+	let onVideoLoad: any;
+	let onVideoAction: any;
+	let onVideoUploadError: any;
+	let onVideoDeleteBefore: any;
+	let audioUploadHandler: any;
+	let onAudioUploadBefore: any;
+	let onAudioUploadError: any;
+	let onAudioLoad: any;
+	let onAudioAction: any;
+	let onAudioDeleteBefore: any;
+	let onFileUploadBefore: any;
+	let onFileLoad: any;
+	let onFileAction: any;
+	let onFileUploadError: any;
+	let onFileDeleteBefore: any;
+	let onExportPDFBefore: any;
+	let onFileManagerAction: any;
+	let onEmbedInputBefore: any;
+	let onEmbedDeleteBefore: any;
+}
+export default _default;
+export type ControllerInstance = import('./modules/Controller').default;
+export type BaseEvent = {
+	/**
+	 * - The root editor instance
+	 */
+	editor: __se__EditorCore;
+	/**
+	 * - frame context
+	 */
+	frameContext: __se__FrameContext;
+	/**
+	 * - event object
+	 */
+	event: Event;
+};
+export type ClipboardEvent = {
+	/**
+	 * - The root editor instance
+	 */
+	editor: __se__EditorCore;
+	/**
+	 * - frame context
+	 */
+	frameContext: __se__FrameContext;
+	/**
+	 * - event object
+	 */
+	event: Event;
+	/**
+	 * - drop data
+	 */
+	data: string;
+	/**
+	 * - is max char count
+	 */
+	maxCharCount: boolean;
+	/**
+	 * - "SE"|"MS"|"" - source
+	 */
+	from: string;
+};
+export type ControllerInfo_events = import('./modules/Controller').ControllerInfo;
+export type FileManagementInfo = {
+	/**
+	 * - source URL of the image.
+	 */
+	src: string;
+	/**
+	 * - index of the image.
+	 */
+	index: number;
+	/**
+	 * - name of the file.
+	 */
+	name: string;
+	/**
+	 * -  size of the file in bytes.
+	 */
+	size: number;
+	/**
+	 * -  target element.
+	 */
+	element: HTMLElement;
+	/**
+	 * -  delete function.
+	 */
+	delete: () => void;
+	/**
+	 * -  select function.
+	 */
+	select: () => void;
+};
+export type ProcessInfo = {
+	/**
+	 * - origin url
+	 */
+	origin: string;
+	/**
+	 * - url
+	 */
+	url: string;
+	/**
+	 * - tag name
+	 */
+	tag: 'video' | 'iframe';
+	/**
+	 * - embed children tags
+	 */
+	children: HTMLCollection | null;
+};
+export type ImageInfo = {
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - target element
+	 */
+	element: HTMLImageElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - Anchor element, if it exists
+	 */
+	anchor: HTMLElement | null;
+	/**
+	 * - alt text value
+	 */
+	alt: string;
+};
+export type VideoInfo = {
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - target element
+	 */
+	element: HTMLIFrameElement | HTMLVideoElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - video url
+	 */
+	url: string;
+	/**
+	 * - video process info
+	 */
+	process: ProcessInfo | null;
+};
+export type AudioInfo = {
+	/**
+	 * - target element
+	 */
+	element: HTMLAudioElement;
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+};
+export type FileInfo = {
+	/**
+	 * - file url
+	 */
+	url: string;
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - upload headers
+	 */
+	uploadHeaders: any;
+};
+export type EmbedInfo = {
+	/**
+	 * - target element
+	 */
+	element: HTMLElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - embed url
+	 */
+	url: string;
+	/**
+	 * - When the input source is stacked in an iframe, etc., the actual embedded DOM
+	 */
+	children: HTMLElement | null;
+	/**
+	 * - embed process info
+	 */
+	process: ProcessInfo | null;
+};