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

package/types/plugins/popup/anchor.d.ts

@@ -0,0 +1,56 @@
+export default Anchor;
+/**
+ * @class
+ * @description Anchor plugin
+ * - Allows you to create, edit, and delete elements that act as anchors (bookmarks) within a document.
+ */
+declare class Anchor extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @this {Anchor}
+	 * @param {HTMLElement} node - The node to check.
+	 * @returns {HTMLElement|null} Returns a node if the node is a valid component.
+	 */
+	static component(this: Anchor, node: HTMLElement): HTMLElement | null;
+	title: any;
+	icon: string;
+	bookmarkIcon: HTMLElement;
+	_element: HTMLElement;
+	_range: Range;
+	displayId: Element;
+	controllerSelect: Controller;
+	inputEl: HTMLInputElement;
+	controller: Controller;
+	/**
+	 * @editorMethod Editor.Plugin<popup>
+	 * @description Displays a popup and gives focus to the input field.
+	 */
+	show(): void;
+	/**
+	 * @editorMethod Editor.component
+	 * @description Executes the method that is called when a component of a plugin is selected.
+	 * @param {HTMLElement} target Target component element
+	 */
+	select(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.Component
+	 * @description Called when a container is deselected.
+	 */
+	deselect(): void;
+	/**
+	 * @editorMethod Modules.Controller
+	 * @description Executes the method that is called when a button is clicked in the "controller".
+	 * @param {HTMLButtonElement} target Target button element
+	 */
+	controllerAction(target: HTMLButtonElement): void;
+	/**
+	 * @private
+	 * @description Initializes state variables.
+	 * - called when the popup is closed
+	 */
+	private _init;
+}
+import EditorInjector from '../../editorInjector';
+import { Controller } from '../../modules';

package/types/suneditor.d.ts

@@ -0,0 +1,51 @@
+declare namespace _default {
+	/**
+	 * Returns the create function with preset options.
+	 * If the options overlap, the options of the 'create' function take precedence.
+	 * @param {EditorInitOptions_suneditor} init_options - Initialization options
+	 * @returns {{create: (targets: Element|Object<string, {target: Element, options: EditorFrameOptions_suneditor}>, options: EditorInitOptions_suneditor) => Editor}}}
+	 */
+	function init(init_options: EditorInitOptions_suneditor): {
+		create: (
+			targets:
+				| Element
+				| {
+						[x: string]: {
+							target: Element;
+							options: EditorFrameOptions_suneditor;
+						};
+				  },
+			options: EditorInitOptions_suneditor
+		) => Editor;
+	};
+	/**
+	 * Creates a new instance of the SunEditor
+	 * @param {Element|Object<string, {target: Element, options: EditorFrameOptions_suneditor}>} target - Target element or multi-root object
+	 * @param {EditorInitOptions_suneditor} options - Initialization options
+	 * @param {EditorInitOptions_suneditor} [_init_options] - Optional preset initialization options
+	 * @returns {Editor} - Instance of the SunEditor
+	 * @throws {Error} If the target element is not provided or is invalid
+	 */
+	function create(
+		target:
+			| Element
+			| {
+					[x: string]: {
+						target: Element;
+						options: EditorFrameOptions_suneditor;
+					};
+			  },
+		options: EditorInitOptions_suneditor,
+		_init_options?: EditorInitOptions_suneditor
+	): Editor;
+}
+export default _default;
+export type EditorFrameOptions_suneditor = import('./core/section/constructor').EditorFrameOptions;
+export type EditorInitOptions_suneditor = import('./core/section/constructor').EditorInitOptions;
+import EditorInjector from './editorInjector';
+import Plugins from './plugins';
+import Modules from './modules';
+import Langs from './langs';
+import Helper from './helper';
+import Editor from './core/editor';
+export { EditorInjector, Plugins, Modules, Langs, Helper };

package/types/typedef.d.ts

@@ -0,0 +1,233 @@
+export {};
+
+declare global {
+	type __se__NodeCollection = Array<Node> | HTMLCollection | NodeList;
+	type __se__EditorCore = import('./core/editor').default;
+	type __se__EditorInjector = import('./editorInjector').default;
+	type __se__CoreInjector = import('./editorInjector/_core').default;
+	type __se__ComponentInfo = {
+		/**
+		 * - The target element associated with the component.
+		 */
+		target: HTMLElement;
+		/**
+		 * - The name of the plugin related to the component.
+		 */
+		pluginName: string;
+		/**
+		 * - Options related to the component.
+		 */
+		options: {
+			[x: string]: any;
+		};
+		/**
+		 * - The main container element for the component.
+		 */
+		container: HTMLElement;
+		/**
+		 * - The cover element, if applicable.
+		 */
+		cover: HTMLElement | null;
+		/**
+		 * - The inline cover element, if applicable.
+		 */
+		inlineCover: HTMLElement | null;
+		/**
+		 * - The caption element, if applicable.
+		 */
+		caption: HTMLElement | null;
+		/**
+		 * - Whether the component is a file-related component.
+		 */
+		isFile: boolean;
+		/**
+		 * - The element that triggered the component, if applicable.
+		 */
+		launcher: HTMLElement | null;
+		/**
+		 * - Whether the component is an input component (e.g., table).
+		 */
+		isInputType: boolean;
+	};
+	type __se__EditorStatus = {
+		/**
+		 * Boolean value of whether the editor has focus
+		 */
+		hasFocus: boolean;
+		/**
+		 * Indent size of tab (4)
+		 */
+		tabSize: number;
+		/**
+		 * Indent size (25)px
+		 */
+		indentSize: number;
+		/**
+		 * Indent size of Code view mode (2)
+		 */
+		codeIndentSize: number;
+		/**
+		 * An element array of the current cursor's node structure
+		 */
+		currentNodes: Array<string>;
+		/**
+		 * An element name array of the current cursor's node structure
+		 */
+		currentNodesMap: Array<string>;
+		/**
+		 * Boolean value of whether component is selected
+		 */
+		onSelected: boolean;
+		/**
+		 * Current root key
+		 */
+		rootKey: number;
+		/**
+		 * Current range object
+		 */
+		_range: Range;
+		/**
+		 * Mouse down event status
+		 */
+		_onMousedown: boolean;
+	};
+	type __se__EventInfo = {
+		/**
+		 * Target element
+		 */
+		target: any;
+		/**
+		 * Event type
+		 */
+		type: string;
+		/**
+		 * Event listener
+		 */
+		listener: (...args: any) => any;
+		/**
+		 * Event useCapture option
+		 */
+		useCapture?: (boolean | AddEventListenerOptions) | undefined;
+	};
+	type __se__GlobalEventInfo = {
+		/**
+		 * Event type
+		 */
+		type: string;
+		/**
+		 * Event listener
+		 */
+		listener: (...args: any) => any;
+		/**
+		 * Use event capture
+		 */
+		useCapture?: (boolean | AddEventListenerOptions) | undefined;
+	};
+	type __se__PluginMouseEventInfo = {
+		/**
+		 * Frame context
+		 */
+		frameContext: __se__FrameContext;
+		/**
+		 * Event object
+		 */
+		event: MouseEvent;
+	};
+	type __se__PluginKeyEventInfo = {
+		/**
+		 * Frame context
+		 */
+		frameContext: __se__FrameContext;
+		/**
+		 * Event object
+		 */
+		event: KeyboardEvent;
+		/**
+		 * range object
+		 */
+		range: Range;
+		/**
+		 * Current line element
+		 */
+		line: HTMLElement;
+	};
+	type __se__PluginToolbarInputChangeEventInfo = {
+		/**
+		 * Input element
+		 */
+		target: HTMLElement;
+		/**
+		 * Event object
+		 */
+		event: Event;
+		/**
+		 * Input value
+		 */
+		value: string;
+	};
+	/**
+	 * Information of the "shortcut" plugin
+	 */
+	type __se__PluginShortcutInfo = {
+		/**
+		 * - Range object
+		 */
+		range: Range;
+		/**
+		 * - The line element of the current range
+		 */
+		line: HTMLElement;
+		/**
+		 * - Information of the shortcut
+		 */
+		info: import('./core/class/shortcuts').ShortcutInfo;
+		/**
+		 * - Key event object
+		 */
+		event: KeyboardEvent;
+		/**
+		 * - KeyBoardEvent.code
+		 */
+		keyCode: string;
+		/**
+		 * - The root editor instance
+		 */
+		editor: __se__EditorCore;
+	};
+	type __se__PluginPasteParams = {
+		/**
+		 * Frame context
+		 */
+		frameContext: __se__FrameContext;
+		/**
+		 * Clipboard event object
+		 */
+		event: ClipboardEvent;
+		/**
+		 * Format cleaned paste data (HTML string)
+		 */
+		data: string;
+		/**
+		 * DomParser data (new DOMParser().parseFromString(data, 'text/html');)
+		 */
+		doc: Document;
+	};
+	type __se__PluginCopyComponentParams = {
+		/**
+		 * Clipboard event object
+		 */
+		event: ClipboardEvent;
+		/**
+		 * Cloned component container
+		 */
+		cloneContainer: HTMLElement;
+		/**
+		 * Component information
+		 */
+		info: __se__ComponentInfo;
+	};
+	type __se__FrameOptions = Map<string, any>;
+	type __se__FrameContext = Map<string, any>;
+	type __se__Context = Map<string, any>;
+	type __se__Class_OffsetGlobalInfo = import('./core/class/offset').OffsetGlobalInfo;
+}

package/.eslintignore

@@ -1,7 +0,0 @@
-node_modules
-dist
-sample
-test
-karma.conf.js
-webpack/**/*
-**/*.css

package/.eslintrc.json

@@ -1,64 +0,0 @@
-{
-	"plugins": ["prettier", "@typescript-eslint"],
-	"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:@typescript-eslint/eslint-recommended", "plugin:@typescript-eslint/recommended"],
-	"parser": "@typescript-eslint/parser",
-	"parserOptions": {
-		"ecmaVersion": 2020,
-		"sourceType": "module"
-	},
-	"env": {
-		"browser": true,
-		"node": true,
-		"es6": true
-	},
-	"globals": {
-		"ActiveXObject": "writable",
-		"Selection": "writable",
-		"Node": "writable",
-		"Range": "writable"
-	},
-	"rules": {
-		"eqeqeq": "error",
-		"strict": ["error", "safe"],
-		"no-undef": "error",
-		"no-unused-vars": "warn",
-		"no-loop-func": "off",
-		"no-shadow": "error",
-		"no-unused-expressions": "off",
-		"curly": "off",
-		"prefer-const": "error",
-		"no-var": "error",
-		"no-console": ["warn", { "allow": ["warn", "error"] }],
-		"prettier/prettier": [
-			"error",
-			{
-				"arrowParens": "always",
-				"bracketSpacing": true,
-				"endOfLine": "auto",
-				"htmlWhitespaceSensitivity": "css",
-				"insertPragma": false,
-				"jsxBracketSameLine": false,
-				"jsxSingleQuote": true,
-				"printWidth": 240,
-				"proseWrap": "preserve",
-				"quoteProps": "as-needed",
-				"requirePragma": false,
-				"semi": true,
-				"singleQuote": true,
-				"tabWidth": 4,
-				"trailingComma": "none",
-				"useTabs": true,
-				"vueIndentScriptAndStyle": false
-			}
-		]
-	},
-	"overrides": [
-		{
-			"files": ["*.d.ts"],
-			"rules": {
-				"no-unused-vars": "off",
-				"@typescript-eslint/no-unused-vars": "off"
-			}
-		}
-	]
-}