suneditor 3.0.0-alpha.2 → 3.0.0-alpha.20

package/types/plugins/dropdown/align.d.ts

@@ -0,0 +1,60 @@
+export default Align;
+/**
+ * @class
+ * @description Align plugin
+ */
+declare class Align extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array.<"right"|"center"|"left"|"justify">} pluginOptions.items - Align items
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<'right' | 'center' | 'left' | 'justify'>;
+		}
+	);
+	title: any;
+	icon: string;
+	_itemMenu: HTMLUListElement;
+	defaultDir: string;
+	alignIcons: {
+		justify: string;
+		left: string;
+		right: string;
+		center: string;
+	};
+	alignList: NodeListOf<Element>;
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the method called when the rtl, ltr mode changes. ("editor.setDir")
+	 * @param {string} dir Direction ("rtl" or "ltr")
+	 */
+	setDir(dir: string): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/backgroundColor.d.ts

@@ -0,0 +1,63 @@
+export default BackgroundColor;
+/**
+ * @class
+ * @description Text background color plugin
+ */
+declare class BackgroundColor extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<string|{value: string, name: string}>} pluginOptions.items - Color list
+	 * @param {number} pluginOptions.splitNum - Number of colors per line
+	 * @param {boolean} pluginOptions.disableHEXInput - Disable HEX input
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<
+				| string
+				| {
+						value: string;
+						name: string;
+				  }
+			>;
+			splitNum: number;
+			disableHEXInput: boolean;
+		}
+	);
+	title: any;
+	icon: string;
+	colorPicker: ColorPicker;
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's "dropdown" menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's "dropdown" menu is closed.
+	 */
+	off(): void;
+	/**
+	 * @editorMethod Modules.ColorPicker
+	 * @description Executes the method called when a button of "ColorPicker" module is clicked.
+	 * - This plugin is by applying the "ColorPicker" module globally to the "dropdown" menu, the default "action" method is not called.
+	 * @param {string} color - Color code (hex)
+	 */
+	colorPickerAction(color: string): void;
+}
+import EditorInjector from '../../editorInjector';
+import ColorPicker from '../../modules/ColorPicker';

package/types/plugins/dropdown/font.d.ts

@@ -0,0 +1,54 @@
+export default Font;
+/**
+ * @class
+ * @description Text font plugin
+ */
+declare class Font extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<string>} pluginOptions.items - Font list
+	 * @param {number} pluginOptions.splitNum - Number of colors per line
+	 * @param {boolean} pluginOptions.disableHEXInput - Disable HEX input
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<string>;
+			splitNum: number;
+			disableHEXInput: boolean;
+		}
+	);
+	title: any;
+	inner: string;
+	currentFont: string;
+	fontList: NodeListOf<Element>;
+	fontArray: string[];
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 * @returns {Promise<void>}
+	 */
+	action(target: HTMLElement): Promise<void>;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/fontColor.d.ts

@@ -0,0 +1,63 @@
+export default FontColor;
+/**
+ * @class
+ * @description Font color plugin
+ */
+declare class FontColor extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<string|{value: string, name: string}>} pluginOptions.items - Color list
+	 * @param {number} pluginOptions.splitNum - Number of colors per line
+	 * @param {boolean} pluginOptions.disableHEXInput - Disable HEX input
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<
+				| string
+				| {
+						value: string;
+						name: string;
+				  }
+			>;
+			splitNum: number;
+			disableHEXInput: boolean;
+		}
+	);
+	title: any;
+	icon: string;
+	colorPicker: ColorPicker;
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @Override Executes the method that is called when a plugin's dropdown menu is closed.
+	 */
+	off(): void;
+	/**
+	 * @editorMethod Modules.ColorPicker
+	 * @description Executes the method called when a button of "ColorPicker" module is clicked.
+	 * - This plugin is by applying the "ColorPicker" module globally to the "dropdown" menu, the default "action" method is not called.
+	 * @param {string} color - Color code (hex)
+	 */
+	colorPickerAction(color: string): void;
+}
+import EditorInjector from '../../editorInjector';
+import ColorPicker from '../../modules/ColorPicker';

package/types/plugins/dropdown/formatBlock.d.ts

@@ -0,0 +1,58 @@
+export default FormatBlock;
+export type ShortcutInfo = import('../../core/class/shortcuts').ShortcutInfo;
+/**
+ * @typedef {import('../../core/class/shortcuts').ShortcutInfo} ShortcutInfo
+ */
+/**
+ * @class
+ * @description FormatBlock Plugin (P, BLOCKQUOTE, PRE, H1, H2...)
+ */
+declare class FormatBlock extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<string>} pluginOptions.items - Format list
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<string>;
+		}
+	);
+	title: any;
+	inner: string;
+	formatList: NodeListOf<Element>;
+	currentFormat: string;
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+	/**
+	 * @description Create a header tag, call by "shortcut" class
+	 * - (e.g. shortcuts._h1: ['c+s+49+p~formatBlock.createHeader', ''])
+	 * @param {ShortcutInfo} params - Information of the shortcut
+	 */
+	createHeader({ keyCode }: ShortcutInfo): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/hr.d.ts

@@ -0,0 +1,81 @@
+export default HR;
+export type ShortcutInfo = import('../../core/class/shortcuts').ShortcutInfo;
+/**
+ * @typedef {import('../../core/class/shortcuts').ShortcutInfo} ShortcutInfo
+ */
+/**
+ * @class
+ * @description HR Plugin
+ */
+declare class HR extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @this {HR}
+	 * @param {HTMLElement} node - The node to check.
+	 * @returns {HTMLElement|null} Returns a node if the node is a valid component.
+	 */
+	static component(this: HR, node: HTMLElement): HTMLElement | null;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<{name: string, class: string}>} pluginOptions.items - HR list
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<{
+				name: string;
+				class: string;
+			}>;
+		}
+	);
+	title: any;
+	icon: string;
+	list: NodeListOf<HTMLButtonElement>;
+	/**
+	 * @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.
+	 * @param {HTMLElement} element Target element
+	 */
+	deselect(element: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.Component
+	 * @description Method to delete a component of a plugin, called by the "FileManager", "Controller" module.
+	 * @param {HTMLElement} target Target element
+	 */
+	destroy(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes methods called by shortcut keys.
+	 * @param {Object} params - Information of the "shortcut" plugin
+	 * @param {Range} params.range - Range object
+	 * @param {HTMLElement} params.line - The line element of the current range
+	 * @param {ShortcutInfo} params.info - Information of the shortcut
+	 * @param {KeyboardEvent} params.event - Key event object
+	 * @param {string} params.keyCode - KeyBoardEvent.code
+	 * @param {__se__EditorCore} params.editor - The root editor instance
+	 */
+	shortcut({ line, range }: { range: Range; line: HTMLElement; info: ShortcutInfo; event: KeyboardEvent; keyCode: string; editor: __se__EditorCore }): void;
+	/**
+	 * @description Add a hr element
+	 * @param {string} className HR class name
+	 */
+	submit(className: string): HTMLElement;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/layout.d.ts

@@ -0,0 +1,40 @@
+export default Layout;
+/**
+ * @class
+ * @description Layout Plugin, Apply layout to the entire editor.
+ */
+declare class Layout extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<{name: string, html: string}>} pluginOptions.items - Layout list
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<{
+				name: string;
+				html: string;
+			}>;
+		}
+	);
+	title: any;
+	icon: string;
+	selectedIndex: number;
+	items: {
+		name: string;
+		html: string;
+	}[];
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/lineHeight.d.ts

@@ -0,0 +1,50 @@
+export default LineHeight;
+/**
+ * @class
+ * @description Line height Plugin
+ */
+declare class LineHeight extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<{text: string, value: number}>} pluginOptions.items - Line height list
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<{
+				text: string;
+				value: number;
+			}>;
+		}
+	);
+	title: any;
+	icon: string;
+	sizeList: NodeListOf<Element>;
+	currentSize: any;
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 */
+	on(): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/list.d.ts

@@ -0,0 +1,39 @@
+export default List;
+/**
+ * @class
+ * @description List Plugin (OL, UL)
+ */
+declare class List extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	title: any;
+	icon: string;
+	listItems: NodeListOf<Element>;
+	icons: {
+		bulleted: string;
+		numbered: string;
+	};
+	/**
+	 * @editorMethod Editor.EventManager
+	 * @description Executes the method that is called whenever the cursor position changes.
+	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
+	 * @param {?HTMLElement=} target - The plugin's toolbar button element
+	 * @returns {boolean} - Whether the plugin is active
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 * @param {HTMLElement} target Line element at the current cursor position
+	 */
+	on(target: HTMLElement): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/paragraphStyle.d.ts

@@ -0,0 +1,54 @@
+export default ParagraphStyle;
+/**
+ * @class
+ * @description A plugin to style lines using classes.
+ */
+declare class ParagraphStyle extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+     * @constructor
+     * @param {__se__EditorCore} editor - The root editor instance
+     * @param {Object} pluginOptions
+     * @param {Array<string|{name: string, class: string, _class: string}>} pluginOptions.items - Paragraph item list
+     * @example
+     * use default paragraph styles
+     * ['spaced', 'bordered', 'neon']
+     * custom paragraph styles
+        [
+            { name: 'spaced', class: '__se__p-spaced', _class: '' },
+            { name: 'bordered', class: '__se__p-bordered', _class: '' },
+            { name: 'neon', class: '__se__p-neon', _class: ''}
+        ]
+     */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<
+				| string
+				| {
+						name: string;
+						class: string;
+						_class: string;
+				  }
+			>;
+		}
+	);
+	title: any;
+	icon: string;
+	classList: NodeListOf<Element>;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 */
+	on(): void;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - Called when an item in the "dropdown" menu is clicked.
+	 * @param {HTMLElement} target - The plugin's toolbar button element
+	 */
+	action(target: HTMLElement): void;
+}
+import EditorInjector from '../../editorInjector';