@ckeditor/ckeditor5-comments 41.3.0-alpha.3 → 41.3.0

package/dist/translations/ug.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/ug.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'ug':{'dictionary':{'Comment\x20editor':'ئىنكاس\x20تەھرىرلىگۈچ','NUMBER_OF_COMMENTS':['%0\x20ئىنكاس','%0\x20ئىنكاس'],'TOO_LONG_COMMENT_ALERT':'ئىنكاس\x20مەزمۇنى\x20بەك\x20ئۇزۇن.\x20ئىنكاسىڭىز\x20%0\x20ھەرپ\x20ئەمما\x20چېكى\x20%1\x20ھەرپ.','Reply...':'جاۋاب...','Reply\x20to\x20reopen\x20discussion...':'قايتا\x20ئېچىلغان\x20سۆزلىشىشكە\x20ئىنكاس\x20قايتۇرىدۇ…','Write\x20a\x20comment...':'ئىنكاس\x20يېزىش...','Comment\x20was\x20made\x20on\x20an\x20element':'ئېلېمېنتقا\x20ئىنكاس\x20يېزىلغان','Edit':'تەھرىرلەش','Resolve':'ھەل\x20قىل','Reopen':'قايتا\x20ئاچ','Remove':'چىقىرىۋېتىش','Reply':'جاۋاب','Delete\x20comment?':'ئىنكاسنى\x20ئۆچۈرەمسىز؟','Delete\x20comment\x20thread?':'ئىنكاس\x20باغلىمىنى\x20ئۆچۈرەمسىز؟','Marked\x20as\x20resolved':'ھەل\x20قىلىندى\x20بەلگىسى\x20سېلىنغان','Comment':'ئىنكاس','ENTER_COMMENT_ANNOUNCEMENT':'ئىنكاسقا\x20كىرىش.','LEAVE_COMMENT_ANNOUNCEMENT':'ئىنكاستىن\x20چىقىش.','PENDING_ACTION_COMMENT_THREAD':'ئىنكاس\x20رايونىدا\x20ساقلانمىغان\x20ئۆزگەرتىش\x20مەۋجۇت','EXTERNAL_COMMENT':'بۇ\x20ئىنكاس\x20سىرتقى\x20مەنبەدىن\x20كەلگەن.','EXTERNAL_IMPORT_WORD_COMMENT':'بۇ\x20ئىنكاس\x20ئەكىرىلگەن\x20Word\x20ھۆججىتىدىن\x20كەلگەن.','EXTERNAL_AVATAR':'كۆرۈنگەن\x20يازغۇچىنىڭ\x20ئىسمى\x20سىرتقى\x20مەنبە\x20(قوشقۇچى\x20%0)\x20دىن\x20كەلگەن','EXTERNAL_IMPORT_WORD_AVATAR':'كۆرۈنگەن\x20يازغۇچىنىڭ\x20ئىسمى\x20%0\x20ئەكىرگەن\x20Wordھۆججىتىدىن\x20دىن\x20كەلگەن','COMMENTS_ARCHIVE':'ئىنكاس\x20ئارخىپى','EMPTY_COMMENTS_ARCHIVE':'ئارخىپلانغان\x20ھېچقانداق\x20ئىنكاس\x20يوق.'},'getPluralForm':_0xe3853e=>0x1!=_0xe3853e}};

package/dist/translations/uk.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/uk.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'uk':{'dictionary':{'Comment\x20editor':'Редактор\x20коментарів','NUMBER_OF_COMMENTS':['%0\x20Коментар','%0\x20Коментаря','%0\x20Коментарів','%0\x20Коментарів'],'TOO_LONG_COMMENT_ALERT':'Коментар\x20задовгий.\x20Ваш\x20коментар\x20містить\x20%0\x20знак\x20із\x20%1\x20допустимих.','Reply...':'Відповісти...','Reply\x20to\x20reopen\x20discussion...':'Відповісти,\x20щоб\x20відновити\x20обговорення...','Write\x20a\x20comment...':'Написати\x20коментар...','Comment\x20was\x20made\x20on\x20an\x20element':'Було\x20зроблено\x20коментар\x20до\x20елемента','Edit':'Редагувати','Resolve':'Вирішити','Reopen':'Відновити','Remove':'Видалити','Reply':'Відповісти','Delete\x20comment?':'Видалити\x20коментар?','Delete\x20comment\x20thread?':'Видати\x20ланцюжок\x20коментарів?','Marked\x20as\x20resolved':'Позначено\x20як\x20вирішене','Comment':'Коментар','ENTER_COMMENT_ANNOUNCEMENT':'Вхід\x20у\x20коментар.','LEAVE_COMMENT_ANNOUNCEMENT':'Вихід\x20з\x20коментаря.','PENDING_ACTION_COMMENT_THREAD':'Незбережена\x20зміна\x20ланцюжка\x20коментарів.','EXTERNAL_COMMENT':'Цей\x20коментар\x20походить\x20від\x20зовнішнього\x20джерела.','EXTERNAL_IMPORT_WORD_COMMENT':'Цей\x20коментар\x20походить\x20з\x20імпортованого\x20Word\x20файлу.','EXTERNAL_AVATAR':'Показане\x20ім\x27я\x20автора\x20походить\x20із\x20зовнішнього\x20джерела\x20(доданого\x20%0)','EXTERNAL_IMPORT_WORD_AVATAR':'Показане\x20ім\x27я\x20автора\x20походить\x20із\x20документу\x20Word\x20імпортованого\x20%0','COMMENTS_ARCHIVE':'Архів\x20коментарів','EMPTY_COMMENTS_ARCHIVE':'Немає\x20архівних\x20гілок\x20коментарів.'},'getPluralForm':_0x4be636=>_0x4be636%0x1==0x0&&_0x4be636%0xa==0x1&&_0x4be636%0x64!=0xb?0x0:_0x4be636%0x1==0x0&&_0x4be636%0xa>=0x2&&_0x4be636%0xa<=0x4&&(_0x4be636%0x64<0xc||_0x4be636%0x64>0xe)?0x1:_0x4be636%0x1==0x0&&(_0x4be636%0xa==0x0||_0x4be636%0xa>=0x5&&_0x4be636%0xa<=0x9||_0x4be636%0x64>=0xb&&_0x4be636%0x64<=0xe)?0x2:0x3}};

package/dist/translations/ur.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/ur.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'ur':{'dictionary':{'Comment\x20editor':'تبصرہ\x20ایڈیٹر','NUMBER_OF_COMMENTS':['0%\x20تبصرہ','0%\x20تبصرے'],'TOO_LONG_COMMENT_ALERT':'آپ\x20کا\x20تبصرہ\x20طویل\x20ہے۔\x20آپ\x20کے\x20تبصرے\x20میں\x200%\x20حروف\x20ہیں\x20جبکہ\x201%\x20حروف\x20کی\x20حد\x20ہے۔','Reply...':'جواب۔۔۔','Reply\x20to\x20reopen\x20discussion...':'','Write\x20a\x20comment...':'تبصرہ\x20کریں۔۔۔','Comment\x20was\x20made\x20on\x20an\x20element':'','Edit':'ترمیم','Resolve':'','Reopen':'','Remove':'حذف\x20کریں','Reply':'','Delete\x20comment?':'تبصرہ\x20حذف\x20کریں؟','Delete\x20comment\x20thread?':'تبصرے\x20کا\x20دھاگہ\x20حذف\x20کریں؟','Marked\x20as\x20resolved':'','Comment':'تبصرہ','ENTER_COMMENT_ANNOUNCEMENT':'','LEAVE_COMMENT_ANNOUNCEMENT':'','PENDING_ACTION_COMMENT_THREAD':'تبصرے\x20دھاگے\x20میں\x20غیر\x20محفوظ\x20تبدیلیاں\x20ہیں۔','EXTERNAL_COMMENT':'','EXTERNAL_IMPORT_WORD_COMMENT':'','EXTERNAL_AVATAR':'','EXTERNAL_IMPORT_WORD_AVATAR':'','COMMENTS_ARCHIVE':'','EMPTY_COMMENTS_ARCHIVE':''},'getPluralForm':_0x507dab=>0x1!=_0x507dab}};

package/dist/translations/vi.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/vi.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'vi':{'dictionary':{'Comment\x20editor':'Trình\x20chỉnh\x20sửa\x20bình\x20luận','NUMBER_OF_COMMENTS':'%0\x20Bình\x20luận','TOO_LONG_COMMENT_ALERT':'Nội\x20dung\x20bình\x20luận\x20quá\x20dài.\x20Bình\x20luận\x20của\x20bạn\x20có\x20%0\x20ký\x20tự,\x20tuy\x20nhiên\x20giới\x20hạn\x20ký\x20tự\x20là\x20%1.','Reply...':'Trả\x20lời...','Reply\x20to\x20reopen\x20discussion...':'Trả\x20lời\x20để\x20mở\x20lại\x20cuộc\x20thảo\x20luận...','Write\x20a\x20comment...':'Viết\x20bình\x20luận...','Comment\x20was\x20made\x20on\x20an\x20element':'Bình\x20luận\x20được\x20tạo\x20trên\x20một\x20yếu\x20tố','Edit':'Chỉnh\x20sửa','Resolve':'Xử\x20lí','Reopen':'Mở\x20lại','Remove':'Xóa','Reply':'Trả\x20lời','Delete\x20comment?':'Xóa\x20bình\x20luận?','Delete\x20comment\x20thread?':'Xóa\x20chuỗi\x20bình\x20luận?','Marked\x20as\x20resolved':'Đánh\x20dấu\x20là\x20đã\x20xử\x20lí','Comment':'Bình\x20luận','ENTER_COMMENT_ANNOUNCEMENT':'Đang\x20nhập\x20bình\x20luận.','LEAVE_COMMENT_ANNOUNCEMENT':'Đang\x20viết\x20bình\x20luận.','PENDING_ACTION_COMMENT_THREAD':'Nội\x20dung\x20thay\x20đổi\x20chưa\x20lưu\x20trong\x20chuỗi\x20bình\x20luận.','EXTERNAL_COMMENT':'Nhận\x20xét\x20này\x20đến\x20từ\x20một\x20nguồn\x20bên\x20ngoài.','EXTERNAL_IMPORT_WORD_COMMENT':'Bình\x20luận\x20này\x20đến\x20từ\x20một\x20tệp\x20Word\x20được\x20nhập.','EXTERNAL_AVATAR':'Tên\x20tác\x20giả\x20được\x20hiển\x20thị\x20đến\x20từ\x20nguồn\x20bên\x20ngoài\x20\x20(do\x20%0\x20thêm\x20vào)','EXTERNAL_IMPORT_WORD_AVATAR':'Tên\x20tác\x20giả\x20được\x20hiển\x20thị\x20đến\x20từ\x20một\x20tài\x20liệu\x20Word\x20do\x20%0\x20nhập','COMMENTS_ARCHIVE':'Kho\x20lưu\x20trữ\x20bình\x20luận','EMPTY_COMMENTS_ARCHIVE':'Không\x20có\x20chủ\x20đề\x20bình\x20luận\x20nào\x20được\x20lưu\x20trữ.'},'getPluralForm':_0x3d7066=>0x0}};

package/dist/translations/zh-cn.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/zh-cn.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'zh-cn':{'dictionary':{'Comment\x20editor':'评论插件','NUMBER_OF_COMMENTS':'%0\x20条评论','TOO_LONG_COMMENT_ALERT':'评论内容过长。评论内容长度必须大于%0个字符而小于%1个字符。','Reply...':'回复...','Reply\x20to\x20reopen\x20discussion...':'回复以重新开启讨论……','Write\x20a\x20comment...':'编写评论...','Comment\x20was\x20made\x20on\x20an\x20element':'对元素进行了评论','Edit':'编辑','Resolve':'解决','Reopen':'重新开启','Remove':'删除','Reply':'回复','Delete\x20comment?':'删除这条评论？','Delete\x20comment\x20thread?':'删除这组评论？','Marked\x20as\x20resolved':'标记为已解决','Comment':'评论','ENTER_COMMENT_ANNOUNCEMENT':'进入评论。','LEAVE_COMMENT_ANNOUNCEMENT':'离开评论。','PENDING_ACTION_COMMENT_THREAD':'评论区有未保存内容','EXTERNAL_COMMENT':'此评论来自外部来源。','EXTERNAL_IMPORT_WORD_COMMENT':'此评论来自导入的\x20Word\x20文件。','EXTERNAL_AVATAR':'显示的作者名来自（%0\x20添加的）外部来源','EXTERNAL_IMPORT_WORD_AVATAR':'显示的作者名来自\x20%0\x20导入的\x20Word\x20文件','COMMENTS_ARCHIVE':'评论存档','EMPTY_COMMENTS_ARCHIVE':'没有已存档的评论。'},'getPluralForm':_0x2c60ae=>0x0}};

package/dist/translations/zh.d.ts

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-import type { Translations } from 'ckeditor5';
-declare const translations: Translations;
-export default translations;

package/dist/translations/zh.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-export default{'zh':{'dictionary':{'Comment\x20editor':'留言編輯器','NUMBER_OF_COMMENTS':'%0\x20則留言','TOO_LONG_COMMENT_ALERT':'留言內容太長。你的留言有\x20%0\x20個字，上限字數為\x20%1。','Reply...':'回覆...','Reply\x20to\x20reopen\x20discussion...':'回覆以重新開啟討論...','Write\x20a\x20comment...':'撰寫留言...','Comment\x20was\x20made\x20on\x20an\x20element':'對元件進行的留言','Edit':'編輯','Resolve':'解決','Reopen':'重新開啟','Remove':'刪除','Reply':'回覆','Delete\x20comment?':'刪除留言？','Delete\x20comment\x20thread?':'刪除討論串？','Marked\x20as\x20resolved':'已標記為解決','Comment':'留言','ENTER_COMMENT_ANNOUNCEMENT':'正在進入留言。','LEAVE_COMMENT_ANNOUNCEMENT':'正在留下留言。','PENDING_ACTION_COMMENT_THREAD':'討論串尚未儲存。','EXTERNAL_COMMENT':'此留言來自外部來源。','EXTERNAL_IMPORT_WORD_COMMENT':'此留言來自匯入的\x20Word\x20檔案。','EXTERNAL_AVATAR':'顯示的作者名稱來自外部來源（由\x20%0\x20新增）','EXTERNAL_IMPORT_WORD_AVATAR':'顯示的作者名稱來自由\x20%0\x20匯入的\x20Word\x20文件','COMMENTS_ARCHIVE':'留言封存紀錄','EMPTY_COMMENTS_ARCHIVE':'無封存的留言串。'},'getPluralForm':_0x4e8c18=>0x0}};

package/dist/types/annotations/annotation.d.ts

@@ -1,94 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/annotations/annotation
- * @publicApi
- */
-import { Rect, Collection } from 'ckeditor5/src/utils.js';
-import type { View } from 'ckeditor5/src/ui.js';
-import type AnnotationView from './view/annotationview.js';
-import type { AnnotationOptions } from './annotations.js';
-declare const Annotation_base: {
-    new (): import("ckeditor5/src/utils.js").Observable;
-    prototype: import("ckeditor5/src/utils.js").Observable;
-};
-/**
- * Represents an annotation.
- *
- * Annotation is an entity that combines an {@link module:comments/annotations/view/annotationview~AnnotationView}
- * and an annotation target (a DOM element or a {@link module:utils/dom/rect~Rect}) to which the annotation is bound.
- */
-export default class Annotation extends Annotation_base {
-    /**
-     * The visibility of the annotation. Annotations that are not visible, are filtered from Annotation UI collections.
-     *
-     * @observable
-     */
-    isVisible: boolean;
-    /**
-     * The annotation view.
-     */
-    view: AnnotationView;
-    /**
-     * A collection of DOM elements which, when focused, make the annotation active.
-     *
-     * By default, this collection only contains the annotation view element.
-     * It can be extended with custom targets that will be tracked by the annotation focus tracking system.
-     */
-    focusableElements: Collection<HTMLElement>;
-    /**
-     * Creates an instance of the {@link module:comments/annotations/annotation~Annotation}.
-     */
-    constructor({ view, target, type, isVisible }: AnnotationOptions);
-    /**
-     * The type of the annotation.
-     */
-    get type(): string;
-    /**
-     * The annotation inner view.
-     *
-     * It is the view that is wrapped by the annotation view.*
-     */
-    get innerView(): View;
-    /**
-     * The annotation target to which the annotation view should be pinned.
-     *
-     * It can be an array of DOM elements or {@link module:utils/dom/rect~Rect a rect instance} or `null`.
-     */
-    get target(): Rect | Array<HTMLElement> | null;
-    /**
-     * The position and dimensions of the annotation target to which the annotation is bound.
-     */
-    get targetRect(): Rect | null;
-    /**
-     * The state of the annotation.
-     */
-    get isActive(): boolean;
-    set isActive(value: boolean);
-    /**
-     * Updates the target rect in the annotation view instance.
-     */
-    updateTargetRect(): void;
-    /**
-     * Clears all event listeners and internal collections.
-     */
-    destroy(): void;
-    /**
-     * Refreshes the visibility of the annotation based on the visibility of the annotation target.
-     *
-     * It sets the {@link #isVisible} property when the target is not attached to DOM or if the target or its descendant has
-     * set the `display` attribute to `none`.
-     *
-     * This method only updates an annotation if the annotation target is an HTML Element.
-     */
-    refreshVisibility(): void;
-}
-type Target = Rect | HTMLElement | null;
-export type AnnotationTarget = Target | (() => Target | Array<Target>);
-export {};

package/dist/types/annotations/annotationcollection.d.ts

@@ -1,102 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/annotations/annotationcollection
- * @publicApi
- */
-import { Collection } from 'ckeditor5/src/utils.js';
-import type { View } from 'ckeditor5/src/ui.js';
-import type Annotation from './annotation.js';
-/**
- * A collection of {@link module:comments/annotations/annotation~Annotation annotations}.
- *
- * It implements methods for managing annotations and creates a focus tracker for them to make it easier to manage
- * the focus for all annotations.
- *
- * `AnnotationCollection` fires {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:focus} when an annotation
- * becomes focused and {@link module:comments/annotations/annotationcollection~AnnotationCollection#event:blur} when all annotations
- * lose focus.
- */
-export default class AnnotationCollection extends Collection<Annotation> {
-    /**
-     * @param annotations Initial annotations.
-     */
-    constructor(annotations?: Iterable<Annotation>);
-    /**
-    * Equals to `true` when one of the annotation in the collection is focused.
-    */
-    get isFocused(): boolean;
-    /**
-     * Adds an annotation to the collection.
-     */
-    add(annotation: Annotation): this;
-    /**
-     * Removes the annotation from the collection.
-     */
-    remove(annotation: Annotation): Annotation;
-    /**
-     * Gets the annotation for a given annotation view's inner view.
-     */
-    getByInnerView(innerView: View): Annotation | undefined;
-    /**
-     * Gets the annotation for a given annotation view.
-     */
-    getByView(view: View): Annotation | undefined;
-    /**
-     * Destroys all bindings and clears the collection.
-     */
-    destroy(): void;
-    /**
-     * Refreshes the positioning of all annotations and sorts them topmost and leftmost.
-     */
-    refreshPositioning(): void;
-}
-/**
- * Fired when an annotation becomes active.
- *
- * @eventName ~AnnotationCollection#focus
- * @param annotation An annotation that was focused.
- */
-export type AnnotationFocusEvent = {
-    name: 'focus';
-    args: [annotation: Annotation];
-};
-/**
- * Fired when all annotations become blurred.
- *
- * @eventName ~AnnotationCollection#blur
- */
-export type AnnotationBlurEvent = {
-    name: 'blur';
-    args: [];
-};
-/**
- * A helper function that binds two {@link module:comments/annotations/annotationcollection~AnnotationCollection AnnotationCollection}s
- * and allows filtering items based on the passed callback.
- *
- * Since {@link module:comments/annotations/annotationcollection~AnnotationCollection#refreshPositioning}
- * sorts the annotations by removing and inserting items, the binding implemented by the `bindTo()` method is lost. This is why
- * this helper needs to be used.
- *
- * This helper is used by the annotations UIs to filter which annotations from the
- * {@link module:comments/annotations/annotations~Annotations#collection main annotation collection} should be handled by
- * a given annotations UI.
- *
- * @param `options.source` The source collection
- * from which the annotations will be taken.
- * @param `options.target` The target collection
- * that will be synced to the source collection.
- * @param options.filter Filtering function that gets an annotation and should return `true` if the annotation should be
- * copied to the `target` collection.
- */
-export declare function bindAnnotationCollections({ source, target, filter }: {
-    source: AnnotationCollection;
-    target: AnnotationCollection;
-    filter: (annotation: Annotation) => boolean;
-}): void;

package/dist/types/annotations/annotations.d.ts

@@ -1,158 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module comments/annotations/annotations
- * @publicApi
- */
-import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core.js';
-import type { View } from 'ckeditor5/src/ui.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-import Annotation, { type AnnotationTarget } from './annotation.js';
-import AnnotationCollection from './annotationcollection.js';
-import AnnotationView, { type AnnotationMainView } from './view/annotationview.js';
-/**
- * Stores and manages all {@link module:comments/annotations/annotation~Annotation annotations} created
- * for the entire {@link module:core/context~Context} or {@link module:core/editor/editor~Editor}.
- *
- * It allows for {@link module:comments/annotations/annotations~Annotations#add adding} and
- * {@link module:comments/annotations/annotations~Annotations#remove removing} annotations.
- *
- * It manages {@link module:comments/annotations/annotations~Annotations#activate activating} and
- * {@link module:comments/annotations/annotations~Annotations#deactivateAll deactivating} annotations. Using those methods will
- * result in setting {@link module:comments/annotations/annotationsuis~AnnotationUI#activeAnnotation} in the appropriate
- * {@link module:comments/annotations/annotationsuis~AnnotationsUI annotations UI} plugins.
- *
- * All active annotations are stored in {@link module:comments/annotations/annotations~Annotations#activeAnnotations}.
- *
- * `Annotations` is linked with {@link module:comments/annotations/annotationsuis~AnnotationsUIs}, which listens to events fired by
- * `Annotations` and propagates information to and from annotations UI plugins.
- */
-export default class Annotations extends ContextPlugin {
-    /**
-     * A set of currently active annotations.
-     *
-     * @observable
-     */
-    activeAnnotations: Set<Annotation>;
-    /**
-     * A collection of all annotations. It should not be operated on directly.
-     */
-    readonly collection: AnnotationCollection;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Annotations";
-    /**
-     * @inheritDoc
-     */
-    constructor(context: Context | Editor);
-    /**
-     * Adds an annotation to the collection.
-     */
-    add(annotation: Annotation): void;
-    /**
-     * Removes the given annotation from the collection.
-     */
-    remove(annotation: Annotation): void;
-    /**
-     * Refreshes the visibility of annotations based on the visibility of their annotation targets.
-     *
-     * This method should be called when one or more annotations' targets changed their visibility,
-     * for example when one of the editors was shown or hidden.
-     *
-     * This method recalculates all annotations' {@link module:comments/annotations/annotation~Annotation#isVisible `isVisible`} property.
-     */
-    refreshVisibility(): void;
-    /**
-     * Refreshes the positioning of all visible annotations and sorts them topmost and leftmost.
-     */
-    refreshPositioning(): void;
-    /**
-     * Returns the annotation that "contains" the given annotation view's inner view.
-     */
-    getByInnerView(innerView: View): Annotation | undefined;
-    /**
-     * Deactivates all active annotations.
-     *
-     * @fires _deactivateAllAnnotations
-     */
-    deactivateAll(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Activates the given annotation.
-     *
-     * If annotations UI that handles the given annotation already has an active annotation,
-     * then it deactivates it and activates the provided one.
-     *
-     * @fires _activateAnnotation
-     */
-    activate(annotation: Annotation): void;
-    /**
-     * Creates an annotation.
-     *
-     * ```ts
-     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
-     *
-     * const annotation = annotations.createAnnotation( {
-     * 	view: annotationView,
-     * 	target: document.getElementById( 'target' ),
-     * 	type: 'comment'
-     * } );
-     * ```
-     *
-     * @returns An annotation.
-     */
-    createAnnotation(options: AnnotationOptions): Annotation;
-    /**
-     * Creates an annotation view wrapper for the annotation content.
-     *
-     * ```ts
-     * const innerView = createCustomView();
-     * const annotationView = annotations.createAnnotationView( editor.locale, innerView );
-     * ```
-     *
-     * @returns An annotation view.
-     */
-    createAnnotationView(locale: Locale, view: AnnotationMainView): AnnotationView;
-}
-/**
- * The configuration options which are used to create new {@link module:comments/annotations/annotation~Annotation annotations}.
- *
- * @param view The annotation view.
- * @param target The annotation target.
- * @param type The annotation type.
- * @param isVisible The initial visibility of the annotation.
- */
-export interface AnnotationOptions {
-    view: AnnotationView;
-    target: AnnotationTarget;
-    type: string | (() => string);
-    isVisible?: boolean;
-}
-/**
- * An internal event that fires when the annotation should be activated.
- *
- * @eventName ~Annotations#_activateAnnotation
- */
-export type ActivateAnnotationEvent = {
-    name: '_activateAnnotation';
-    args: [annotation: Annotation];
-};
-/**
- * An internal event that fires when all annotations should be deactivated.
- *
- * @eventName ~Annotations#_deactivateAllAnnotations
- */
-export type DeactivateAllAnnotationsEvent = {
-    name: '_deactivateAllAnnotations';
-    args: [];
-};