@ckeditor/ckeditor5-mention 45.2.1 → 46.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-mention",
-  "version": "45.2.1",
+  "version": "46.0.0-alpha.1",
   "description": "Mention feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,12 +13,12 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "45.2.1",
-    "@ckeditor/ckeditor5-typing": "45.2.1",
-    "@ckeditor/ckeditor5-ui": "45.2.1",
-    "@ckeditor/ckeditor5-utils": "45.2.1",
-    "ckeditor5": "45.2.1",
-    "es-toolkit": "1.32.0"
+    "@ckeditor/ckeditor5-core": "46.0.0-alpha.1",
+    "@ckeditor/ckeditor5-typing": "46.0.0-alpha.1",
+    "@ckeditor/ckeditor5-ui": "46.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "46.0.0-alpha.1",
+    "ckeditor5": "46.0.0-alpha.1",
+    "es-toolkit": "1.39.5"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "SEE LICENSE IN LICENSE.md",

package/src/index.d.ts

@@ -5,12 +5,14 @@
 /**
  * @module mention
  */
-export { default as Mention } from './mention.js';
-export { default as MentionEditing } from './mentionediting.js';
-export { default as MentionUI } from './mentionui.js';
-export { default as MentionsView } from './ui/mentionsview.js';
-export { default as MentionListItemView } from './ui/mentionlistitemview.js';
-export { default as DomWrapperView } from './ui/domwrapperview.js';
-export type { MentionConfig, MentionFeed, ItemRenderer, MentionFeedObjectItem } from './mentionconfig.js';
-export type { default as MentionCommand } from './mentioncommand.js';
+export { Mention, type MentionAttribute } from './mention.js';
+export { MentionEditing } from './mentionediting.js';
+export { MentionUI } from './mentionui.js';
+export { MentionsView } from './ui/mentionsview.js';
+export { MentionListItemView } from './ui/mentionlistitemview.js';
+export { MentionDomWrapperView } from './ui/domwrapperview.js';
+export { MentionCommand } from './mentioncommand.js';
+export type { MentionConfig, MentionFeed, MentionFeedItem, MentionItemRenderer, MentionFeedObjectItem, MentionFeedbackCallback } from './mentionconfig.js';
+export { createRegExp as _createMentionMarkerRegExp } from './mentionui.js';
+export { _addMentionAttributes as _addMentionAttributes, _toMentionAttribute as _toMentionAttribute } from './mentionediting.js';
 import './augmentation.js';

package/src/index.js

@@ -5,10 +5,13 @@
 /**
  * @module mention
  */
-export { default as Mention } from './mention.js';
-export { default as MentionEditing } from './mentionediting.js';
-export { default as MentionUI } from './mentionui.js';
-export { default as MentionsView } from './ui/mentionsview.js';
-export { default as MentionListItemView } from './ui/mentionlistitemview.js';
-export { default as DomWrapperView } from './ui/domwrapperview.js';
+export { Mention } from './mention.js';
+export { MentionEditing } from './mentionediting.js';
+export { MentionUI } from './mentionui.js';
+export { MentionsView } from './ui/mentionsview.js';
+export { MentionListItemView } from './ui/mentionlistitemview.js';
+export { MentionDomWrapperView } from './ui/domwrapperview.js';
+export { MentionCommand } from './mentioncommand.js';
+export { createRegExp as _createMentionMarkerRegExp } from './mentionui.js';
+export { _addMentionAttributes as _addMentionAttributes, _toMentionAttribute as _toMentionAttribute } from './mentionediting.js';
 import './augmentation.js';

package/src/mention.d.ts

@@ -6,16 +6,16 @@
  * @module mention/mention
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import type { Element } from 'ckeditor5/src/engine.js';
-import MentionEditing from './mentionediting.js';
-import MentionUI from './mentionui.js';
+import type { ModelElement } from 'ckeditor5/src/engine.js';
+import { MentionEditing } from './mentionediting.js';
+import { MentionUI } from './mentionui.js';
 import '../theme/mention.css';
 /**
  * The mention plugin.
  *
  * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
  */
-export default class Mention extends Plugin {
+export declare class Mention extends Plugin {
     /**
      * Creates a mention attribute value from the provided view element and additional data.
      *
@@ -29,7 +29,7 @@ export default class Mention extends Plugin {
      *
      * @param data Additional data to be stored in the mention attribute.
      */
-    toMentionAttribute<MentionData extends Record<string, unknown>>(viewElement: Element, data: MentionData): (MentionAttribute & MentionData) | undefined;
+    toMentionAttribute<MentionData extends Record<string, unknown>>(viewElement: ModelElement, data: MentionData): (MentionAttribute & MentionData) | undefined;
     /**
      * Creates a mention attribute value from the provided view element.
      *
@@ -41,7 +41,7 @@ export default class Mention extends Plugin {
      * // { id: '@joe', uid: '7a7bc7...', _text: '@John Doe' }
      * ```
      */
-    toMentionAttribute(viewElement: Element): MentionAttribute | undefined;
+    toMentionAttribute(viewElement: ModelElement): MentionAttribute | undefined;
     /**
      * @inheritDoc
      */
@@ -68,7 +68,7 @@ export type MentionAttribute = {
     id: string;
     /**
      * A unique ID of this mention instance. Should be passed as an `option.id` when using
-     * {@link module:engine/view/downcastwriter~DowncastWriter#createAttributeElement writer.createAttributeElement()}.
+     * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement writer.createAttributeElement()}.
      */
     uid: string;
     /**

package/src/mention.js

@@ -6,15 +6,15 @@
  * @module mention/mention
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import MentionEditing, { _toMentionAttribute } from './mentionediting.js';
-import MentionUI from './mentionui.js';
+import { MentionEditing, _toMentionAttribute } from './mentionediting.js';
+import { MentionUI } from './mentionui.js';
 import '../theme/mention.css';
 /**
  * The mention plugin.
  *
  * For a detailed overview, check the {@glink features/mentions Mention feature} guide.
  */
-export default class Mention extends Plugin {
+export class Mention extends Plugin {
     toMentionAttribute(viewElement, data) {
         return _toMentionAttribute(viewElement, data);
     }

package/src/mentioncommand.d.ts

@@ -6,7 +6,7 @@
  * @module mention/mentioncommand
  */
 import { Command, type Editor } from 'ckeditor5/src/core.js';
-import type { Range } from 'ckeditor5/src/engine.js';
+import type { ModelRange } from 'ckeditor5/src/engine.js';
 /**
  * The mention command.
  *
@@ -43,7 +43,7 @@ import type { Range } from 'ckeditor5/src/engine.js';
  * } );
  *	```
  */
-export default class MentionCommand extends Command {
+export declare class MentionCommand extends Command {
     /**
      * @inheritDoc
      */
@@ -72,6 +72,6 @@ export default class MentionCommand extends Command {
         };
         marker: string;
         text?: string;
-        range?: Range;
+        range?: ModelRange;
     }): void;
 }

package/src/mentioncommand.js

@@ -49,7 +49,7 @@ const BRACKET_PAIRS = {
  * } );
  *	```
  */
-export default class MentionCommand extends Command {
+export class MentionCommand extends Command {
     /**
      * @inheritDoc
      */

package/src/mentionconfig.d.ts

@@ -172,7 +172,7 @@ export interface MentionFeed {
      * a static configuration (the mention feature will show matching items automatically) or a function which returns an array of
      * matching items (directly, or via a promise). If a function is passed, it is executed in the context of the editor instance.
      */
-    feed: Array<MentionFeedItem> | FeedCallback;
+    feed: Array<MentionFeedItem> | MentionFeedbackCallback;
     /**
      * Specifies after how many characters the autocomplete panel should be shown.
      *
@@ -183,7 +183,7 @@ export interface MentionFeed {
      * A function that renders a {@link module:mention/mentionconfig~MentionFeedItem}
      * to the autocomplete panel.
      */
-    itemRenderer?: ItemRenderer;
+    itemRenderer?: MentionItemRenderer;
     /**
      * Specify how many available elements per feeds will the users be able to see in the dropdown list.
      * If it not set, limit is inherited from {@link module:mention/mentionconfig~MentionConfig#dropdownLimit MentionConfig}.
@@ -193,11 +193,11 @@ export interface MentionFeed {
 /**
  * Function that renders an array of {@link module:mention/mentionconfig~MentionFeedItem} based on string input.
  */
-export type FeedCallback = (searchString: string) => Array<MentionFeedItem> | Promise<Array<MentionFeedItem>>;
+export type MentionFeedbackCallback = (searchString: string) => Array<MentionFeedItem> | Promise<Array<MentionFeedItem>>;
 /**
  * Function that takes renders a {@link module:mention/mentionconfig~MentionFeedObjectItem} as HTMLElement.
  */
-export type ItemRenderer = (item: MentionFeedObjectItem) => HTMLElement | string;
+export type MentionItemRenderer = (item: MentionFeedObjectItem) => HTMLElement | string;
 /**
  * The mention feed item. It may be defined as a string or a plain object.
  *

package/src/mentionediting.d.ts

@@ -6,7 +6,7 @@
  * @module mention/mentionediting
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import type { Element } from 'ckeditor5/src/engine.js';
+import type { ModelElement } from 'ckeditor5/src/engine.js';
 import type { MentionAttribute } from './mention.js';
 /**
  * The mention editing feature.
@@ -15,7 +15,7 @@ import type { MentionAttribute } from './mention.js';
  * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
  * as a `<span class="mention" data-mention="@mention">`.
  */
-export default class MentionEditing extends Plugin {
+export declare class MentionEditing extends Plugin {
     /**
      * @inheritDoc
      */
@@ -44,4 +44,4 @@ export declare function _addMentionAttributes(baseMentionData: {
  *
  * @internal
  */
-export declare function _toMentionAttribute(viewElementOrMention: Element, data?: Record<string, unknown>): MentionAttribute | undefined;
+export declare function _toMentionAttribute(viewElementOrMention: ModelElement, data?: Record<string, unknown>): MentionAttribute | undefined;

package/src/mentionediting.js

@@ -7,7 +7,7 @@
  */
 import { Plugin } from 'ckeditor5/src/core.js';
 import { uid } from 'ckeditor5/src/utils.js';
-import MentionCommand from './mentioncommand.js';
+import { MentionCommand } from './mentioncommand.js';
 /**
  * The mention editing feature.
  *
@@ -15,7 +15,7 @@ import MentionCommand from './mentioncommand.js';
  * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
  * as a `<span class="mention" data-mention="@mention">`.
  */
-export default class MentionEditing extends Plugin {
+export class MentionEditing extends Plugin {
     /**
      * @inheritDoc
      */

package/src/mentionui.d.ts

@@ -10,7 +10,7 @@ import { ContextualBalloon } from 'ckeditor5/src/ui.js';
 /**
  * The mention UI feature.
  */
-export default class MentionUI extends Plugin {
+export declare class MentionUI extends Plugin {
     /**
      * The mention view.
      */
@@ -102,5 +102,7 @@ export default class MentionUI extends Plugin {
  * Creates a RegExp pattern for the marker.
  *
  * Function has to be exported to achieve 100% code coverage.
+ *
+ * @internal
  */
 export declare function createRegExp(marker: string, minimumCharacters: number): RegExp;

package/src/mentionui.js

@@ -10,9 +10,9 @@ import { ButtonView, ContextualBalloon, clickOutsideHandler } from 'ckeditor5/sr
 import { CKEditorError, Collection, Rect, env, keyCodes, logWarning } from 'ckeditor5/src/utils.js';
 import { TextWatcher } from 'ckeditor5/src/typing.js';
 import { debounce } from 'es-toolkit/compat';
-import MentionsView from './ui/mentionsview.js';
-import DomWrapperView from './ui/domwrapperview.js';
-import MentionListItemView from './ui/mentionlistitemview.js';
+import { MentionsView } from './ui/mentionsview.js';
+import { MentionDomWrapperView } from './ui/domwrapperview.js';
+import { MentionListItemView } from './ui/mentionlistitemview.js';
 const VERTICAL_SPACING = 3;
 // The key codes that mention UI handles when it is open (without commit keys).
 const defaultHandledKeyCodes = [
@@ -28,7 +28,7 @@ const defaultCommitKeyCodes = [
 /**
  * The mention UI feature.
  */
-export default class MentionUI extends Plugin {
+export class MentionUI extends Plugin {
     /**
      * The mention view.
      */
@@ -384,7 +384,7 @@ export default class MentionUI extends Plugin {
         if (renderer) {
             const renderResult = renderer(item);
             if (typeof renderResult != 'string') {
-                view = new DomWrapperView(editor.locale, renderResult);
+                view = new MentionDomWrapperView(editor.locale, renderResult);
             }
             else {
                 label = renderResult;
@@ -544,6 +544,8 @@ function getLastValidMarkerInText(feedsWithPattern, text) {
  * Creates a RegExp pattern for the marker.
  *
  * Function has to be exported to achieve 100% code coverage.
+ *
+ * @internal
  */
 export function createRegExp(marker, minimumCharacters) {
     const numberOfCharacters = minimumCharacters == 0 ? '*' : `{${minimumCharacters},}`;

package/src/ui/domwrapperview.d.ts

@@ -12,7 +12,7 @@ import type { Locale } from 'ckeditor5/src/utils.js';
  *
  * It allows to render any DOM element and use it in mentions list.
  */
-export default class DomWrapperView extends View {
+export declare class MentionDomWrapperView extends View {
     /**
      * The DOM element for which wrapper was created.
      */
@@ -25,7 +25,7 @@ export default class DomWrapperView extends View {
      */
     isOn: boolean;
     /**
-     * Creates an instance of {@link module:mention/ui/domwrapperview~DomWrapperView} class.
+     * Creates an instance of {@link module:mention/ui/domwrapperview~MentionDomWrapperView} class.
      *
      * Also see {@link #render}.
      */

package/src/ui/domwrapperview.js

@@ -11,13 +11,13 @@ import { View } from 'ckeditor5/src/ui.js';
  *
  * It allows to render any DOM element and use it in mentions list.
  */
-export default class DomWrapperView extends View {
+export class MentionDomWrapperView extends View {
     /**
      * The DOM element for which wrapper was created.
      */
     domElement;
     /**
-     * Creates an instance of {@link module:mention/ui/domwrapperview~DomWrapperView} class.
+     * Creates an instance of {@link module:mention/ui/domwrapperview~MentionDomWrapperView} class.
      *
      * Also see {@link #render}.
      */

package/src/ui/mentionlistitemview.d.ts

@@ -7,7 +7,7 @@
  */
 import { ListItemView } from 'ckeditor5/src/ui.js';
 import type { MentionFeedItem } from '../mentionconfig.js';
-export default class MentionListItemView extends ListItemView {
+export declare class MentionListItemView extends ListItemView {
     item: MentionFeedItem;
     marker: string;
     highlight(): void;

package/src/ui/mentionlistitemview.js

@@ -6,7 +6,7 @@
  * @module mention/ui/mentionlistitemview
  */
 import { ListItemView } from 'ckeditor5/src/ui.js';
-export default class MentionListItemView extends ListItemView {
+export class MentionListItemView extends ListItemView {
     item;
     marker;
     highlight() {

package/src/ui/mentionsview.d.ts

@@ -7,12 +7,12 @@
  */
 import { ListView } from 'ckeditor5/src/ui.js';
 import { type Locale } from 'ckeditor5/src/utils.js';
-import type MentionListItemView from './mentionlistitemview.js';
+import { type MentionListItemView } from './mentionlistitemview.js';
 import '../../theme/mentionui.css';
 /**
  * The mention ui view.
  */
-export default class MentionsView extends ListView {
+export declare class MentionsView extends ListView {
     selected: MentionListItemView | undefined;
     position: string | undefined;
     /**

package/src/ui/mentionsview.js

@@ -11,7 +11,7 @@ import '../../theme/mentionui.css';
 /**
  * The mention ui view.
  */
-export default class MentionsView extends ListView {
+export class MentionsView extends ListView {
     selected;
     position;
     /**