suneditor 3.3.0 → 3.3.1

package/types/plugins/field/slashCommand.d.ts

@@ -54,9 +54,18 @@ export type SlashCommandPluginOptions = {
 	 */
 	delayTime?: number;
 	/**
-	 * - Maximum number of items shown in the dropdown.
+	 * - Maximum number of items kept after filtering. `0` (default) keeps every match
+	 * - the list scrolls within `maxHeight`, so a cap only hides matches the user can no longer reach.
 	 */
 	limitSize?: number;
+	/**
+	 * - Max height of the menu list. Any CSS length; the list scrolls past it.
+	 */
+	maxHeight?: string;
+	/**
+	 * - Min width of the menu.
+	 */
+	minWidth?: string;
 	/**
 	 * - Message shown when no items match the query. If unset, the menu closes on no match.
 	 */
@@ -93,6 +102,15 @@ export type SlashCommandPluginOptions = {
 	 * // A container block (BLOCKQUOTE, DIV…): `applyBlock` WRAPS the selected lines → `<blockquote>…</blockquote>`.
 	 * action: ($) => $.format.applyBlock(document.createElement('BLOCKQUOTE')),
 	 * },
+	 * {
+	 * key: 'table',
+	 * title: 'Table',
+	 * icon: 'table',
+	 * // A plugin-name entry (`'table'`) opens that plugin's own UI — for table, the size picker,
+	 * // which is driven by the pointer. A custom item skips it and inserts straight away, which
+	 * // keeps the whole gesture on the keyboard: type the trigger, press Enter, done.
+	 * action: ($) => $.plugins.table.insert(3, 3),
+	 * },
 	 * 'bold',
 	 * 'image',
 	 * 'blockStyle',
@@ -131,7 +149,10 @@ export type SlashCommandPluginOptions = {
  *   (plugin names, built-in commands like `'bold'`); objects are custom items with their own `action`.
  *   Required.
  * @property {number} [delayTime=120] - Debounce delay (ms) before the input is inspected for the trigger.
- * @property {number} [limitSize=10] - Maximum number of items shown in the dropdown.
+ * @property {number} [limitSize=0] - Maximum number of items kept after filtering. `0` (default) keeps every match
+ *   - the list scrolls within `maxHeight`, so a cap only hides matches the user can no longer reach.
+ * @property {string} [maxHeight='320px'] - Max height of the menu list. Any CSS length; the list scrolls past it.
+ * @property {string} [minWidth='200px'] - Min width of the menu.
  * @property {string} [emptyMessage] - Message shown when no items match the query. If unset, the menu closes on no match.
  * @property {function(SlashCommandItem, { icons: Object }): string} [renderItem] - Custom item HTML renderer.
  *   Applied only to custom item objects; plugin-name entries always render with the canonical BlockHandle row.
@@ -164,6 +185,15 @@ export type SlashCommandPluginOptions = {
  *         // A container block (BLOCKQUOTE, DIV…): `applyBlock` WRAPS the selected lines → `<blockquote>…</blockquote>`.
  *         action: ($) => $.format.applyBlock(document.createElement('BLOCKQUOTE')),
  *       },
+ *       {
+ *         key: 'table',
+ *         title: 'Table',
+ *         icon: 'table',
+ *         // A plugin-name entry (`'table'`) opens that plugin's own UI — for table, the size picker,
+ *         // which is driven by the pointer. A custom item skips it and inserts straight away, which
+ *         // keeps the whole gesture on the keyboard: type the trigger, press Enter, done.
+ *         action: ($) => $.plugins.table.insert(3, 3),
+ *       },
  *       'bold',
  *       'image',
  *       'blockStyle',
@@ -191,6 +221,17 @@ declare class SlashCommand extends PluginField {
 	controller: Controller;
 	onInput(params: SunEditor.HookParams.InputWithData): void;
 	onKeyDown(params: SunEditor.HookParams.KeyEvent): void | boolean;
+	/**
+	 * @description Open the command menu programmatically, with no trigger character typed and the full tem list shown.
+	 * - Intended for host UI that wants the same menu without the `/` shortcut — e.g. the
+	 * - block handle's plus button:
+	 * ```js
+	 * blockHandle: { onPlusClick: ($, { block }) => $.plugins.slashCommand.open(block) }
+	 * ```
+	 * @param {Node} anchorNode - Node the menu anchors to (typically the line the caret sits on).
+	 * @returns {boolean} `true` if the menu was opened
+	 */
+	open(anchorNode: Node): boolean;
 	#private;
 }
 import { PluginField } from '../../interfaces';