suneditor 3.0.0-beta.21 → 3.0.0-beta.22

package/types/plugins/browser/fileBrowser.d.ts

@@ -1,8 +1,44 @@
 export default FileBrowser;
 export type BrowserFile_fileBrowser = import('../../modules/Browser').BrowserFile;
+export type FileBrowserPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?:
+		| {
+				[x: string]: any;
+		  }
+		| Array<any>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: BrowserFile_fileBrowser) => string);
+	/**
+	 * - Additional tag names
+	 */
+	props?: Array<string>;
+};
 /**
  * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileBrowser
  */
+/**
+ * @typedef {Object} FileBrowserPluginOptions
+ * @property {Object<string, *>|Array<*>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: BrowserFile_fileBrowser) => string)} [thumbnail] - Default thumbnail
+ * @property {Array<string>} [props] - Additional tag names
+ */
 /**
  * @class
  * @extends EditorInjector
@@ -15,34 +51,9 @@ declare class FileBrowser extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Object<string, *>|Array<*>=} pluginOptions.data - direct data without server calls
-	 * @param {string} pluginOptions.url - server request url
-	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
-	 * @param {string|((item: BrowserFile_fileBrowser) => string)} pluginOptions.thumbnail - default thumbnail
-	 * @param {Array<string>} pluginOptions.props - additional tag names
+	 * @param {FileBrowserPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?:
-				| (
-						| {
-								[x: string]: any;
-						  }
-						| Array<any>
-				  )
-				| undefined;
-			url: string;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_fileBrowser) => string);
-			props: Array<string>;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: FileBrowserPluginOptions);
 	title: any;
 	icon: string;
 	onSelectfunction: (targe: Node) => any;

package/types/plugins/browser/fileGallery.d.ts

@@ -1,8 +1,35 @@
 export default FileGallery;
 export type BrowserFile_fileGallery = import('../../modules/Browser').BrowserFile;
+export type FileGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<BrowserFile_fileGallery>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: BrowserFile_fileGallery) => string);
+};
 /**
  * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileGallery
  */
+/**
+ * @typedef {Object} FileGalleryPluginOptions
+ * @property {Array<BrowserFile_fileGallery>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: BrowserFile_fileGallery) => string)} [thumbnail] - Default thumbnail
+ */
 /**
  * @class
  * @extends EditorInjector
@@ -15,25 +42,9 @@ declare class FileGallery extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
-	 * @param {string} pluginOptions.url - server request url
-	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
-	 * @param {string|((item: BrowserFile_fileGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 * @param {FileGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url: string;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_fileGallery) => string);
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: FileGalleryPluginOptions);
 	title: any;
 	icon: string;
 	onSelectfunction: (targe: Node) => any;

package/types/plugins/browser/imageGallery.d.ts

@@ -1,4 +1,26 @@
 export default ImageGallery;
+export type ImageGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<any>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+};
+/**
+ * @typedef ImageGalleryPluginOptions
+ * @property {Array<*>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ */
 /**
  * @class
  * @extends EditorInjector
@@ -11,23 +33,9 @@ declare class ImageGallery extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
-	 * @param {string=} pluginOptions.url - server request url
-	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 * @param {ImageGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url?: string | undefined;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: ImageGalleryPluginOptions);
 	title: any;
 	icon: string;
 	onSelectfunction: (targe: Node) => any;

package/types/plugins/browser/videoGallery.d.ts

@@ -1,8 +1,35 @@
 export default VideoGallery;
 export type BrowserFile_videoGallery = import('../../modules/Browser').BrowserFile;
+export type VideoGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<BrowserFile_videoGallery>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: BrowserFile_videoGallery) => string);
+};
 /**
  * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_videoGallery
  */
+/**
+ * @typedef {Object} VideoGalleryPluginOptions
+ * @property {Array<BrowserFile_videoGallery>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: BrowserFile_videoGallery) => string)} [thumbnail] - Default thumbnail
+ */
 /**
  * @class
  * @extends EditorInjector
@@ -15,25 +42,9 @@ declare class VideoGallery extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
-	 * @param {string=} pluginOptions.url - server request url
-	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
-	 * @param {string|((item: BrowserFile_videoGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 * @param {VideoGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url?: string | undefined;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_videoGallery) => string);
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: VideoGalleryPluginOptions);
 	title: any;
 	icon: string;
 	onSelectfunction: (targe: Node) => any;

package/types/plugins/command/exportPDF.d.ts

@@ -1,4 +1,19 @@
 export default ExportPDF;
+export type ExportPDFPluginOptions = {
+	/**
+	 * - Server request URL for PDF generation
+	 */
+	apiUrl: string;
+	/**
+	 * - Name of the generated PDF file
+	 */
+	fileName?: string;
+};
+/**
+ * @typedef ExportPDFPluginOptions
+ * @property {string} apiUrl - Server request URL for PDF generation
+ * @property {string} [fileName="suneditor-pdf"] - Name of the generated PDF file
+ */
 /**
  * @class
  * @description Export PDF plugin
@@ -10,17 +25,9 @@ declare class ExportPDF extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions - plugin options
-	 * @param {string} pluginOptions.apiUrl - server request url
-	 * @param {string} pluginOptions.fileName - file name
+	 * @param {ExportPDFPluginOptions} pluginOptions - plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			apiUrl: string;
-			fileName: string;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: ExportPDFPluginOptions);
 	title: any;
 	icon: string;
 	apiUrl: string;

package/types/plugins/command/fileUpload.d.ts

@@ -1,4 +1,64 @@
 export default FileUpload;
+export type FileUploadPluginOptions = {
+	/**
+	 * - Server request URL for file upload
+	 */
+	uploadUrl: string;
+	/**
+	 * - Server request headers
+	 */
+	uploadHeaders?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Total upload size limit in bytes
+	 */
+	uploadSizeLimit?: string;
+	/**
+	 * - Single file size limit in bytes
+	 */
+	uploadSingleSizeLimit?: string;
+	/**
+	 * - Allow multiple file uploads
+	 */
+	allowMultiple?: boolean;
+	/**
+	 * - Accepted file formats (e.g., 'image/*, .pdf')
+	 */
+	acceptedFormats?: string;
+	/**
+	 * - Specify the default form of the file component as 'box' or 'link'
+	 */
+	as?: string;
+	/**
+	 * - Additional controls to be added to the figure
+	 */
+	controls?: Array<string>;
+	/**
+	 * - Component insertion behavior for selection and cursor placement. [default: options.get('componentInsertBehavior')]
+	 * - `auto`: Move cursor to the next line if possible, otherwise select the component.
+	 * - `select`: Always select the inserted component.
+	 * - `line`: Move cursor to the next line if possible, or create a new line and move there.
+	 * - `none`: Do nothing.
+	 */
+	insertBehavior?: __se__ComponentInsertBehaviorType;
+};
+/**
+ * @typedef FileUploadPluginOptions
+ * @property {string} uploadUrl - Server request URL for file upload
+ * @property {Object<string, string>} [uploadHeaders] - Server request headers
+ * @property {string} [uploadSizeLimit] - Total upload size limit in bytes
+ * @property {string} [uploadSingleSizeLimit] - Single file size limit in bytes
+ * @property {boolean} [allowMultiple=false] - Allow multiple file uploads
+ * @property {string} [acceptedFormats="*"] - Accepted file formats (e.g., 'image/*, .pdf')
+ * @property {string} [as="box"] - Specify the default form of the file component as 'box' or 'link'
+ * @property {Array<string>} [controls] - Additional controls to be added to the figure
+ * @property {__se__ComponentInsertBehaviorType} [insertBehavior] - Component insertion behavior for selection and cursor placement. [default: options.get('componentInsertBehavior')]
+ * - `auto`: Move cursor to the next line if possible, otherwise select the component.
+ * - `select`: Always select the inserted component.
+ * - `line`: Move cursor to the next line if possible, or create a new line and move there.
+ * - `none`: Do nothing.
+ */
 /**
  * @class
  * @description File upload plugin
@@ -19,33 +79,9 @@ declare class FileUpload extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions - plugin options
-	 * @param {string} pluginOptions.uploadUrl - server request url
-	 * @param {Object<string, string>=} pluginOptions.uploadHeaders - server request headers
-	 * @param {string=} pluginOptions.uploadSizeLimit - upload size limit
-	 * @param {string=} pluginOptions.uploadSingleSizeLimit - upload single size limit
-	 * @param {boolean=} pluginOptions.allowMultiple - allow multiple files
-	 * @param {string=} pluginOptions.acceptedFormats - accepted formats
-	 * @param {string=} pluginOptions.as - Whether to use the 'Box' or 'Link' conversion button
-	 * @param {Array<string>} pluginOptions.controls - Additional controls to be added to the figure
-	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			uploadUrl: string;
-			uploadHeaders?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			uploadSizeLimit?: string | undefined;
-			uploadSingleSizeLimit?: string | undefined;
-			allowMultiple?: boolean | undefined;
-			acceptedFormats?: string | undefined;
-			as?: string | undefined;
-			controls: Array<string>;
-		}
-	);
+	 * @param {FileUploadPluginOptions} pluginOptions - plugin options
+	 */
+	constructor(editor: __se__EditorCore, pluginOptions: FileUploadPluginOptions);
 	title: any;
 	icon: string;
 	uploadUrl: string;
@@ -58,6 +94,7 @@ declare class FileUpload extends EditorInjector {
 	acceptedFormats: string;
 	_acceptedCheck: string[];
 	as: string;
+	insertBehavior: __se__ComponentInsertBehaviorType;
 	input: HTMLElement;
 	_element: HTMLElement;
 	figure: Figure;

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

@@ -1,4 +1,14 @@
 export default Align;
+export type AlignPluginOptions = {
+	/**
+	 * - Align items
+	 */
+	items?: Array<'right' | 'center' | 'left' | 'justify'>;
+};
+/**
+ * @typedef {Object} AlignPluginOptions
+ * @property {Array.<"right"|"center"|"left"|"justify">} [items] - Align items
+ */
 /**
  * @class
  * @description Align plugin
@@ -9,15 +19,9 @@ declare class Align extends EditorInjector {
 	static className: string;
 	/**
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array.<"right"|"center"|"left"|"justify">} pluginOptions.items - Align items
+	 * @param {AlignPluginOptions} pluginOptions - Plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<'right' | 'center' | 'left' | 'justify'>;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: AlignPluginOptions);
 	title: any;
 	icon: string;
 	_itemMenu: HTMLUListElement;

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

@@ -1,4 +1,30 @@
 export default BackgroundColor;
+export type BackgroundColorPluginOptions = {
+	/**
+	 * - Color list
+	 */
+	items?: Array<
+		| string
+		| {
+				value: string;
+				name: string;
+		  }
+	>;
+	/**
+	 * - Number of colors per line
+	 */
+	splitNum?: number;
+	/**
+	 * - Disable HEX input
+	 */
+	disableHEXInput?: boolean;
+};
+/**
+ * @typedef {Object} BackgroundColorPluginOptions
+ * @property {Array<string|{value: string, name: string}>} [items] - Color list
+ * @property {number} [splitNum] - Number of colors per line
+ * @property {boolean} [disableHEXInput] - Disable HEX input
+ */
 /**
  * @class
  * @description Text background color plugin
@@ -10,25 +36,9 @@ declare class BackgroundColor extends EditorInjector {
 	/**
 	 * @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
+	 * @param {BackgroundColorPluginOptions} pluginOptions - Plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<
-				| string
-				| {
-						value: string;
-						name: string;
-				  }
-			>;
-			splitNum: number;
-			disableHEXInput: boolean;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: BackgroundColorPluginOptions);
 	title: any;
 	icon: string;
 	colorPicker: ColorPicker;

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

@@ -1,4 +1,14 @@
 export default Font;
+export type FontPluginOptions = {
+	/**
+	 * - Font list
+	 */
+	items?: Array<string>;
+};
+/**
+ * @typedef {Object} FontPluginOptions
+ * @property {Array<string>} [items] - Font list
+ */
 /**
  * @class
  * @description Text font plugin
@@ -10,19 +20,9 @@ declare class Font extends EditorInjector {
 	/**
 	 * @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
+	 * @param {FontPluginOptions} pluginOptions - plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<string>;
-			splitNum: number;
-			disableHEXInput: boolean;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: FontPluginOptions);
 	title: any;
 	inner: string;
 	currentFont: string;

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

@@ -1,4 +1,30 @@
 export default FontColor;
+export type FontColorPluginOptions = {
+	/**
+	 * - Color list
+	 */
+	items?: Array<
+		| string
+		| {
+				value: string;
+				name: string;
+		  }
+	>;
+	/**
+	 * - Number of colors per line
+	 */
+	splitNum?: number;
+	/**
+	 * - Disable HEX input
+	 */
+	disableHEXInput?: boolean;
+};
+/**
+ * @typedef {Object} FontColorPluginOptions
+ * @property {Array<string|{value: string, name: string}>} [items] - Color list
+ * @property {number} [splitNum] - Number of colors per line
+ * @property {boolean} [disableHEXInput] - Disable HEX input
+ */
 /**
  * @class
  * @description Font color plugin
@@ -10,25 +36,9 @@ declare class FontColor extends EditorInjector {
 	/**
 	 * @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
+	 * @param {FontColorPluginOptions} pluginOptions - Plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<
-				| string
-				| {
-						value: string;
-						name: string;
-				  }
-			>;
-			splitNum: number;
-			disableHEXInput: boolean;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: FontColorPluginOptions);
 	title: any;
 	icon: string;
 	colorPicker: ColorPicker;

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

@@ -1,4 +1,14 @@
 export default FormatBlock;
+export type FormatBlockPluginOptions = {
+	/**
+	 * - Format list
+	 */
+	items?: Array<string>;
+};
+/**
+ * @typedef {Object} FormatBlockPluginOptions
+ * @property {Array<string>} [items] - Format list
+ */
 /**
  * @class
  * @description FormatBlock Plugin (P, BLOCKQUOTE, PRE, H1, H2...)
@@ -10,15 +20,9 @@ declare class FormatBlock extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array<string>} pluginOptions.items - Format list
+	 * @param {FormatBlockPluginOptions} pluginOptions - Plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<string>;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: FormatBlockPluginOptions);
 	title: any;
 	inner: string;
 	formatList: NodeListOf<Element>;

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

@@ -1,4 +1,17 @@
 export default HR;
+export type HRPluginOptions = {
+	/**
+	 * - HR list
+	 */
+	items?: Array<{
+		name: string;
+		class: string;
+	}>;
+};
+/**
+ * @typedef {Object} HRPluginOptions
+ * @property {Array<{name: string, class: string}>} [items] - HR list
+ */
 /**
  * @class
  * @description HR Plugin
@@ -16,18 +29,9 @@ declare class HR extends EditorInjector {
 	/**
 	 * @constructor
 	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions
-	 * @param {Array<{name: string, class: string}>} pluginOptions.items - HR list
+	 * @param {HRPluginOptions} pluginOptions - Plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			items: Array<{
-				name: string;
-				class: string;
-			}>;
-		}
-	);
+	constructor(editor: __se__EditorCore, pluginOptions: HRPluginOptions);
 	title: any;
 	icon: string;
 	list: NodeListOf<HTMLButtonElement>;