@ckeditor/ckeditor5-comments 48.2.0-alpha.7 → 48.3.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (195) hide show
  1. package/dist/annotations/annotation.d.ts +84 -87
  2. package/dist/annotations/annotationcollection.d.ts +83 -83
  3. package/dist/annotations/annotations.d.ts +148 -148
  4. package/dist/annotations/annotationsuis.d.ts +235 -235
  5. package/dist/annotations/editorannotations.d.ts +71 -71
  6. package/dist/annotations/inlineannotations.d.ts +93 -93
  7. package/dist/annotations/narrowsidebar.d.ts +88 -88
  8. package/dist/annotations/sidebar.d.ts +105 -105
  9. package/dist/annotations/view/annotationcounterbuttonview.d.ts +24 -24
  10. package/dist/annotations/view/annotationview.d.ts +83 -83
  11. package/dist/annotations/view/sidebaritemview.d.ts +54 -54
  12. package/dist/annotations/view/sidebarview.d.ts +48 -48
  13. package/dist/annotations/widesidebar.d.ts +80 -80
  14. package/dist/augmentation.d.ts +57 -57
  15. package/dist/comments/addcommentthreadcommand.d.ts +69 -69
  16. package/dist/comments/commentsarchive.d.ts +34 -34
  17. package/dist/comments/commentsarchiveui.d.ts +48 -48
  18. package/dist/comments/commentsediting.d.ts +90 -90
  19. package/dist/comments/commentsrepository.d.ts +1042 -1054
  20. package/dist/comments/commentsui.d.ts +40 -40
  21. package/dist/comments/integrations/clipboard.d.ts +21 -21
  22. package/dist/comments/integrations/commentsrestrictededitingmode.d.ts +12 -12
  23. package/dist/comments/integrations/importword.d.ts +16 -16
  24. package/dist/comments/integrations/showcommenthighlights.d.ts +14 -14
  25. package/dist/comments/ui/commenteditor/commenteditor.d.ts +33 -32
  26. package/dist/comments/ui/commenteditor/commenteditorui.d.ts +27 -27
  27. package/dist/comments/ui/commenteditor/commenteditoruiview.d.ts +32 -32
  28. package/dist/comments/ui/commentthreadcontroller.d.ts +62 -60
  29. package/dist/comments/ui/view/basecommentthreadview.d.ts +134 -134
  30. package/dist/comments/ui/view/basecommentview.d.ts +136 -136
  31. package/dist/comments/ui/view/collapsedcommentsview.d.ts +9 -9
  32. package/dist/comments/ui/view/commentcontentview.d.ts +10 -10
  33. package/dist/comments/ui/view/commentinputview.d.ts +93 -93
  34. package/dist/comments/ui/view/commentsarchiveview.d.ts +41 -41
  35. package/dist/comments/ui/view/commentslistview.d.ts +107 -107
  36. package/dist/comments/ui/view/commentthreadheadercontextview.d.ts +19 -19
  37. package/dist/comments/ui/view/commentthreadheaderview.d.ts +67 -67
  38. package/dist/comments/ui/view/commentthreadinputview.d.ts +51 -51
  39. package/dist/comments/ui/view/commentthreadview.d.ts +116 -116
  40. package/dist/comments/ui/view/commentview.d.ts +225 -230
  41. package/dist/comments.d.ts +38 -38
  42. package/dist/commentsonly.d.ts +36 -36
  43. package/dist/config.d.ts +186 -186
  44. package/dist/index.d.ts +35 -35
  45. package/dist/index.js +11 -11
  46. package/dist/translations/af.js +1 -1
  47. package/dist/translations/af.umd.js +1 -1
  48. package/dist/translations/ar.js +1 -1
  49. package/dist/translations/ar.umd.js +1 -1
  50. package/dist/translations/ast.js +1 -1
  51. package/dist/translations/ast.umd.js +1 -1
  52. package/dist/translations/az.js +1 -1
  53. package/dist/translations/az.umd.js +1 -1
  54. package/dist/translations/be.js +1 -1
  55. package/dist/translations/be.umd.js +1 -1
  56. package/dist/translations/bg.js +1 -1
  57. package/dist/translations/bg.umd.js +1 -1
  58. package/dist/translations/bn.js +1 -1
  59. package/dist/translations/bn.umd.js +1 -1
  60. package/dist/translations/bs.js +1 -1
  61. package/dist/translations/bs.umd.js +1 -1
  62. package/dist/translations/ca.js +1 -1
  63. package/dist/translations/ca.umd.js +1 -1
  64. package/dist/translations/cs.js +1 -1
  65. package/dist/translations/cs.umd.js +1 -1
  66. package/dist/translations/da.js +1 -1
  67. package/dist/translations/da.umd.js +1 -1
  68. package/dist/translations/de-ch.js +1 -1
  69. package/dist/translations/de-ch.umd.js +1 -1
  70. package/dist/translations/de.js +1 -1
  71. package/dist/translations/de.umd.js +1 -1
  72. package/dist/translations/el.js +1 -1
  73. package/dist/translations/el.umd.js +1 -1
  74. package/dist/translations/en-au.js +1 -1
  75. package/dist/translations/en-au.umd.js +1 -1
  76. package/dist/translations/en-gb.js +1 -1
  77. package/dist/translations/en-gb.umd.js +1 -1
  78. package/dist/translations/en.js +1 -1
  79. package/dist/translations/en.umd.js +1 -1
  80. package/dist/translations/eo.js +1 -1
  81. package/dist/translations/eo.umd.js +1 -1
  82. package/dist/translations/es-co.js +1 -1
  83. package/dist/translations/es-co.umd.js +1 -1
  84. package/dist/translations/es.js +1 -1
  85. package/dist/translations/es.umd.js +1 -1
  86. package/dist/translations/et.js +1 -1
  87. package/dist/translations/et.umd.js +1 -1
  88. package/dist/translations/eu.js +1 -1
  89. package/dist/translations/eu.umd.js +1 -1
  90. package/dist/translations/fa.js +1 -1
  91. package/dist/translations/fa.umd.js +1 -1
  92. package/dist/translations/fi.js +1 -1
  93. package/dist/translations/fi.umd.js +1 -1
  94. package/dist/translations/fr.js +1 -1
  95. package/dist/translations/fr.umd.js +1 -1
  96. package/dist/translations/gl.js +1 -1
  97. package/dist/translations/gl.umd.js +1 -1
  98. package/dist/translations/gu.js +1 -1
  99. package/dist/translations/gu.umd.js +1 -1
  100. package/dist/translations/he.js +1 -1
  101. package/dist/translations/he.umd.js +1 -1
  102. package/dist/translations/hi.js +1 -1
  103. package/dist/translations/hi.umd.js +1 -1
  104. package/dist/translations/hr.js +1 -1
  105. package/dist/translations/hr.umd.js +1 -1
  106. package/dist/translations/hu.js +1 -1
  107. package/dist/translations/hu.umd.js +1 -1
  108. package/dist/translations/hy.js +1 -1
  109. package/dist/translations/hy.umd.js +1 -1
  110. package/dist/translations/id.js +1 -1
  111. package/dist/translations/id.umd.js +1 -1
  112. package/dist/translations/it.js +1 -1
  113. package/dist/translations/it.umd.js +1 -1
  114. package/dist/translations/ja.js +1 -1
  115. package/dist/translations/ja.umd.js +1 -1
  116. package/dist/translations/jv.js +1 -1
  117. package/dist/translations/jv.umd.js +1 -1
  118. package/dist/translations/kk.js +1 -1
  119. package/dist/translations/kk.umd.js +1 -1
  120. package/dist/translations/km.js +1 -1
  121. package/dist/translations/km.umd.js +1 -1
  122. package/dist/translations/kn.js +1 -1
  123. package/dist/translations/kn.umd.js +1 -1
  124. package/dist/translations/ko.js +1 -1
  125. package/dist/translations/ko.umd.js +1 -1
  126. package/dist/translations/ku.js +1 -1
  127. package/dist/translations/ku.umd.js +1 -1
  128. package/dist/translations/lt.js +1 -1
  129. package/dist/translations/lt.umd.js +1 -1
  130. package/dist/translations/lv.js +1 -1
  131. package/dist/translations/lv.umd.js +1 -1
  132. package/dist/translations/ms.js +1 -1
  133. package/dist/translations/ms.umd.js +1 -1
  134. package/dist/translations/nb.js +1 -1
  135. package/dist/translations/nb.umd.js +1 -1
  136. package/dist/translations/ne.js +1 -1
  137. package/dist/translations/ne.umd.js +1 -1
  138. package/dist/translations/nl.js +1 -1
  139. package/dist/translations/nl.umd.js +1 -1
  140. package/dist/translations/no.js +1 -1
  141. package/dist/translations/no.umd.js +1 -1
  142. package/dist/translations/oc.js +1 -1
  143. package/dist/translations/oc.umd.js +1 -1
  144. package/dist/translations/pl.js +1 -1
  145. package/dist/translations/pl.umd.js +1 -1
  146. package/dist/translations/pt-br.js +1 -1
  147. package/dist/translations/pt-br.umd.js +1 -1
  148. package/dist/translations/pt.js +1 -1
  149. package/dist/translations/pt.umd.js +1 -1
  150. package/dist/translations/ro.js +1 -1
  151. package/dist/translations/ro.umd.js +1 -1
  152. package/dist/translations/ru.js +1 -1
  153. package/dist/translations/ru.umd.js +1 -1
  154. package/dist/translations/si.js +1 -1
  155. package/dist/translations/si.umd.js +1 -1
  156. package/dist/translations/sk.js +1 -1
  157. package/dist/translations/sk.umd.js +1 -1
  158. package/dist/translations/sl.js +1 -1
  159. package/dist/translations/sl.umd.js +1 -1
  160. package/dist/translations/sq.js +1 -1
  161. package/dist/translations/sq.umd.js +1 -1
  162. package/dist/translations/sr-latn.js +1 -1
  163. package/dist/translations/sr-latn.umd.js +1 -1
  164. package/dist/translations/sr.js +1 -1
  165. package/dist/translations/sr.umd.js +1 -1
  166. package/dist/translations/sv.js +1 -1
  167. package/dist/translations/sv.umd.js +1 -1
  168. package/dist/translations/th.js +1 -1
  169. package/dist/translations/th.umd.js +1 -1
  170. package/dist/translations/ti.js +1 -1
  171. package/dist/translations/ti.umd.js +1 -1
  172. package/dist/translations/tk.js +1 -1
  173. package/dist/translations/tk.umd.js +1 -1
  174. package/dist/translations/tr.js +1 -1
  175. package/dist/translations/tr.umd.js +1 -1
  176. package/dist/translations/tt.js +1 -1
  177. package/dist/translations/tt.umd.js +1 -1
  178. package/dist/translations/ug.js +1 -1
  179. package/dist/translations/ug.umd.js +1 -1
  180. package/dist/translations/uk.js +1 -1
  181. package/dist/translations/uk.umd.js +1 -1
  182. package/dist/translations/ur.js +1 -1
  183. package/dist/translations/ur.umd.js +1 -1
  184. package/dist/translations/uz.js +1 -1
  185. package/dist/translations/uz.umd.js +1 -1
  186. package/dist/translations/vi.js +1 -1
  187. package/dist/translations/vi.umd.js +1 -1
  188. package/dist/translations/zh-cn.js +1 -1
  189. package/dist/translations/zh-cn.umd.js +1 -1
  190. package/dist/translations/zh.js +1 -1
  191. package/dist/translations/zh.umd.js +1 -1
  192. package/dist/utils/common-translations.d.ts +6 -6
  193. package/dist/utils/createmutationobserver.d.ts +9 -9
  194. package/dist/utils/splitmarkername.d.ts +10 -10
  195. package/package.json +16 -16
@@ -1,90 +1,90 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module comments/annotations/view/annotationview
7
- * @publicApi
8
- */
9
- import { type FocusableView, View, type ViewCollection } from '@ckeditor/ckeditor5-ui';
10
- import { FocusTracker, KeystrokeHandler, type Rect, type Locale } from '@ckeditor/ckeditor5-utils';
11
- import '../../../theme/annotation.css';
6
+ * @module comments/annotations/view/annotationview
7
+ * @publicApi
8
+ */
9
+ import { type FocusableView, View, type ViewCollection } from "@ckeditor/ckeditor5-ui";
10
+ import { FocusTracker, KeystrokeHandler, type Rect, type Locale } from "@ckeditor/ckeditor5-utils";
11
+ import "../../../theme/annotation.css";
12
12
  /**
13
- * A wrapping view for any view added to the `Annotations` plugin.
14
- *
15
- * It introduces functionalities that make the given view ready to be used as an annotation, such as focus tracking, height resizing,
16
- * and other observable properties that help share current annotation state across different UIs.
17
- */
13
+ * A wrapping view for any view added to the `Annotations` plugin.
14
+ *
15
+ * It introduces functionalities that make the given view ready to be used as an annotation, such as focus tracking, height resizing,
16
+ * and other observable properties that help share current annotation state across different UIs.
17
+ */
18
18
  export declare class AnnotationView extends View implements FocusableView {
19
- /**
20
- * Tracks focus on the annotation view.
21
- *
22
- * Add a DOM element to this focus tracker to prevent blurring annotation view
23
- * when the DOM element is focused.
24
- */
25
- readonly focusTracker: FocusTracker;
26
- readonly id: string;
27
- readonly keystrokes: KeystrokeHandler;
28
- /**
29
- * Target rectangle to which the annotation should be attached.
30
- *
31
- * @observable
32
- */
33
- targetRect: Rect | null;
34
- /**
35
- * Annotation view height.
36
- *
37
- * @observable
38
- */
39
- height: number;
40
- /**
41
- * Informs if an annotation is active.
42
- *
43
- * @observable
44
- */
45
- isActive: boolean;
46
- /**
47
- * Informs if there are unsaved changes in the annotation.
48
- *
49
- * @observable
50
- */
51
- isDirty: boolean;
52
- /**
53
- * The number of items in the annotation.
54
- *
55
- * @observable
56
- */
57
- length: number;
58
- /**
59
- * @observable
60
- */
61
- type: string;
62
- element: HTMLElement;
63
- /**
64
- * Collection for content views.
65
- */
66
- content: ViewCollection<FocusableView>;
67
- /**
68
- * The inner annotation view.
69
- */
70
- mainView: AnnotationMainView;
71
- /**
72
- * @inheritDoc
73
- */
74
- constructor(locale: Locale, mainView: AnnotationMainView);
75
- /**
76
- * @inheritDoc
77
- */
78
- render(): void;
79
- /**
80
- * @inheritDoc
81
- */
82
- destroy(): void;
83
- /**
84
- * Focuses the annotation view.
85
- */
86
- focus(): void;
19
+ /**
20
+ * Tracks focus on the annotation view.
21
+ *
22
+ * Add a DOM element to this focus tracker to prevent blurring annotation view
23
+ * when the DOM element is focused.
24
+ */
25
+ readonly focusTracker: FocusTracker;
26
+ readonly id: string;
27
+ readonly keystrokes: KeystrokeHandler;
28
+ /**
29
+ * Target rectangle to which the annotation should be attached.
30
+ *
31
+ * @observable
32
+ */
33
+ targetRect: Rect | null;
34
+ /**
35
+ * Annotation view height.
36
+ *
37
+ * @observable
38
+ */
39
+ height: number;
40
+ /**
41
+ * Informs if an annotation is active.
42
+ *
43
+ * @observable
44
+ */
45
+ isActive: boolean;
46
+ /**
47
+ * Informs if there are unsaved changes in the annotation.
48
+ *
49
+ * @observable
50
+ */
51
+ isDirty: boolean;
52
+ /**
53
+ * The number of items in the annotation.
54
+ *
55
+ * @observable
56
+ */
57
+ length: number;
58
+ /**
59
+ * @observable
60
+ */
61
+ type: string;
62
+ element: HTMLElement;
63
+ /**
64
+ * Collection for content views.
65
+ */
66
+ content: ViewCollection<FocusableView>;
67
+ /**
68
+ * The inner annotation view.
69
+ */
70
+ mainView: AnnotationMainView;
71
+ /**
72
+ * @inheritDoc
73
+ */
74
+ constructor(locale: Locale, mainView: AnnotationMainView);
75
+ /**
76
+ * @inheritDoc
77
+ */
78
+ override render(): void;
79
+ /**
80
+ * @inheritDoc
81
+ */
82
+ override destroy(): void;
83
+ /**
84
+ * Focuses the annotation view.
85
+ */
86
+ focus(): void;
87
87
  }
88
88
  export interface AnnotationMainView extends FocusableView {
89
- isActive: boolean;
89
+ isActive: boolean;
90
90
  }
@@ -1,59 +1,59 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module comments/annotations/view/sidebaritemview
7
- * @publicApi
8
- */
9
- import { View, type ViewCollection, type FocusableView } from '@ckeditor/ckeditor5-ui';
10
- import { type Locale } from '@ckeditor/ckeditor5-utils';
6
+ * @module comments/annotations/view/sidebaritemview
7
+ * @publicApi
8
+ */
9
+ import { View, type ViewCollection, type FocusableView } from "@ckeditor/ckeditor5-ui";
10
+ import { type Locale } from "@ckeditor/ckeditor5-utils";
11
11
  /**
12
- * A wrapper view that wraps given {@link module:ui/view~View} to display it as a {@link module:comments/annotations/sidebar~Sidebar} item.
13
- */
12
+ * A wrapper view that wraps given {@link module:ui/view~View} to display it as a {@link module:comments/annotations/sidebar~Sidebar} item.
13
+ */
14
14
  export declare class AnnotationsSidebarItemView extends View implements FocusableView {
15
- element: HTMLElement;
16
- /**
17
- * The item top offset.
18
- * Setting `0` as the initial value makes new items falling from heaven.
19
- *
20
- * @observable
21
- */
22
- top: number;
23
- /**
24
- * @observable
25
- */
26
- bottom: number;
27
- /**
28
- * @observable
29
- */
30
- height: number;
31
- /**
32
- * @observable
33
- */
34
- isAnimationDisabled: boolean;
35
- /**
36
- * A collection of content views.
37
- */
38
- content: ViewCollection<FocusableView>;
39
- /**
40
- * @inheritDoc
41
- */
42
- constructor(locale: Locale);
43
- /**
44
- * @inheritDoc
45
- */
46
- render(): void;
47
- /**
48
- * @inheritDoc
49
- */
50
- focus(): void;
51
- /**
52
- * Updates {@link #height the height property} according to the element's DOM height.
53
- */
54
- updateHeight(): void;
55
- /**
56
- * @inheritDoc
57
- */
58
- destroy(): void;
15
+ element: HTMLElement;
16
+ /**
17
+ * The item top offset.
18
+ * Setting `0` as the initial value makes new items falling from heaven.
19
+ *
20
+ * @observable
21
+ */
22
+ top: number;
23
+ /**
24
+ * @observable
25
+ */
26
+ bottom: number;
27
+ /**
28
+ * @observable
29
+ */
30
+ height: number;
31
+ /**
32
+ * @observable
33
+ */
34
+ isAnimationDisabled: boolean;
35
+ /**
36
+ * A collection of content views.
37
+ */
38
+ content: ViewCollection<FocusableView>;
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ constructor(locale: Locale);
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ override render(): void;
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ focus(): void;
51
+ /**
52
+ * Updates {@link #height the height property} according to the element's DOM height.
53
+ */
54
+ updateHeight(): void;
55
+ /**
56
+ * @inheritDoc
57
+ */
58
+ override destroy(): void;
59
59
  }
@@ -1,53 +1,53 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module comments/annotations/view/sidebarview
7
- * @publicApi
8
- */
9
- import { View, FocusCycler, type ViewCollection, type ViewWithFocusCycler } from '@ckeditor/ckeditor5-ui';
10
- import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
11
- import { type AnnotationsSidebarItemView } from './sidebaritemview.js';
12
- import '../../../theme/sidebar.css';
6
+ * @module comments/annotations/view/sidebarview
7
+ * @publicApi
8
+ */
9
+ import { View, FocusCycler, type ViewCollection, type ViewWithFocusCycler } from "@ckeditor/ckeditor5-ui";
10
+ import { FocusTracker, type Locale } from "@ckeditor/ckeditor5-utils";
11
+ import { type AnnotationsSidebarItemView } from "./sidebaritemview.js";
12
+ import "../../../theme/sidebar.css";
13
13
  /**
14
- * The sidebar view class that displays the collection of sidebar item views.
15
- */
14
+ * The sidebar view class that displays the collection of sidebar item views.
15
+ */
16
16
  export declare class AnnotationsSidebarView extends View implements ViewWithFocusCycler {
17
- /**
18
- * @observable
19
- */
20
- minHeight: number | null;
21
- /**
22
- * @observable
23
- */
24
- class: string;
25
- /**
26
- * A collection of sidebar item views.
27
- */
28
- list: ViewCollection<AnnotationsSidebarItemView>;
29
- /**
30
- * A collection of focusable views in the sidebar.
31
- */
32
- focusables: ViewCollection<AnnotationsSidebarItemView>;
33
- /**
34
- * Tracks information about DOM focus among sidebar item views.
35
- */
36
- readonly focusTracker: FocusTracker;
37
- /**
38
- * Helps cycling over {@link #focusables focusable items} in the sidebar.
39
- */
40
- readonly focusCycler: FocusCycler;
41
- /**
42
- * @inheritDoc
43
- */
44
- constructor(locale: Locale);
45
- /**
46
- * @inheritDoc
47
- */
48
- render(): void;
49
- /**
50
- * @inheritDoc
51
- */
52
- focus(): void;
17
+ /**
18
+ * @observable
19
+ */
20
+ minHeight: number | null;
21
+ /**
22
+ * @observable
23
+ */
24
+ class: string;
25
+ /**
26
+ * A collection of sidebar item views.
27
+ */
28
+ list: ViewCollection<AnnotationsSidebarItemView>;
29
+ /**
30
+ * A collection of focusable views in the sidebar.
31
+ */
32
+ focusables: ViewCollection<AnnotationsSidebarItemView>;
33
+ /**
34
+ * Tracks information about DOM focus among sidebar item views.
35
+ */
36
+ readonly focusTracker: FocusTracker;
37
+ /**
38
+ * Helps cycling over {@link #focusables focusable items} in the sidebar.
39
+ */
40
+ readonly focusCycler: FocusCycler;
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ constructor(locale: Locale);
45
+ /**
46
+ * @inheritDoc
47
+ */
48
+ override render(): void;
49
+ /**
50
+ * @inheritDoc
51
+ */
52
+ focus(): void;
53
53
  }
@@ -1,85 +1,85 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module comments/annotations/widesidebar
7
- * @publicApi
8
- */
9
- import { ContextPlugin, Context, type Editor } from '@ckeditor/ckeditor5-core';
10
- import { AnnotationsUIs, type AnnotationsUI } from './annotationsuis.js';
11
- import { Sidebar } from './sidebar.js';
12
- import { type Annotation } from './annotation.js';
13
- import type { AnnotationCollection } from './annotationcollection.js';
6
+ * @module comments/annotations/widesidebar
7
+ * @publicApi
8
+ */
9
+ import { ContextPlugin, Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
10
+ import { AnnotationsUIs, type AnnotationsUI } from "./annotationsuis.js";
11
+ import { Sidebar } from "./sidebar.js";
12
+ import { type Annotation } from "./annotation.js";
13
+ import type { AnnotationCollection } from "./annotationcollection.js";
14
14
  /**
15
- * The wide sidebar UI for displaying annotations.
16
- *
17
- * In this implementation {@link module:comments/annotations/sidebar~Sidebar the sidebar} displays full
18
- * {@link module:comments/annotations/view/annotationview~AnnotationView annotation views}.
19
- *
20
- * To activate this UI use one of the following:
21
- *
22
- * ```ts
23
- * editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'wideSidebar' );
24
- * editor.plugins.get( 'AnnotationsUIs' ).activate( 'wideSidebar', filter );
25
- * ```
26
- *
27
- * See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
28
- */
15
+ * The wide sidebar UI for displaying annotations.
16
+ *
17
+ * In this implementation {@link module:comments/annotations/sidebar~Sidebar the sidebar} displays full
18
+ * {@link module:comments/annotations/view/annotationview~AnnotationView annotation views}.
19
+ *
20
+ * To activate this UI use one of the following:
21
+ *
22
+ * ```ts
23
+ * editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'wideSidebar' );
24
+ * editor.plugins.get( 'AnnotationsUIs' ).activate( 'wideSidebar', filter );
25
+ * ```
26
+ *
27
+ * See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
28
+ */
29
29
  export declare class WideSidebar extends ContextPlugin implements AnnotationsUI<ContextPlugin> {
30
- /**
31
- * An active annotation tracked by this UI.
32
- *
33
- * @observable
34
- */
35
- activeAnnotation: Annotation | null;
36
- isAttached: boolean;
37
- /**
38
- * A collection of annotations controlled by this UI.
39
- *
40
- * This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
41
- *
42
- * It is set to `null` if `WideSidebar` is not {@link module:comments/annotations/widesidebar~WideSidebar#attach attached}.
43
- */
44
- annotations: AnnotationCollection | null;
45
- /**
46
- * @inheritDoc
47
- */
48
- static get requires(): readonly [typeof Sidebar, typeof AnnotationsUIs];
49
- /**
50
- * @inheritDoc
51
- */
52
- static get pluginName(): "WideSidebar";
53
- /**
54
- * @inheritDoc
55
- */
56
- static get isOfficialPlugin(): true;
57
- /**
58
- * @inheritDoc
59
- */
60
- static get isPremiumPlugin(): true;
61
- /**
62
- * @inheritDoc
63
- */
64
- constructor(context: Context | Editor);
65
- /**
66
- * @inheritDoc
67
- */
68
- init(): void;
69
- /**
70
- * Sets the active annotation for this UI.
71
- */
72
- setActiveAnnotation(annotation: Annotation | null): void;
73
- /**
74
- * @inheritDoc
75
- */
76
- attach(annotations: AnnotationCollection): void;
77
- /**
78
- * @inheritDoc
79
- */
80
- detach(): void;
81
- /**
82
- * @inheritDoc
83
- */
84
- destroy(): void;
30
+ /**
31
+ * An active annotation tracked by this UI.
32
+ *
33
+ * @observable
34
+ */
35
+ activeAnnotation: Annotation | null;
36
+ isAttached: boolean;
37
+ /**
38
+ * A collection of annotations controlled by this UI.
39
+ *
40
+ * This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
41
+ *
42
+ * It is set to `null` if `WideSidebar` is not {@link module:comments/annotations/widesidebar~WideSidebar#attach attached}.
43
+ */
44
+ annotations: AnnotationCollection | null;
45
+ /**
46
+ * @inheritDoc
47
+ */
48
+ static get requires(): PluginDependenciesOf<[Sidebar, AnnotationsUIs]>;
49
+ /**
50
+ * @inheritDoc
51
+ */
52
+ static get pluginName(): "WideSidebar";
53
+ /**
54
+ * @inheritDoc
55
+ */
56
+ static override get isOfficialPlugin(): true;
57
+ /**
58
+ * @inheritDoc
59
+ */
60
+ static override get isPremiumPlugin(): true;
61
+ /**
62
+ * @inheritDoc
63
+ */
64
+ constructor(context: Context | Editor);
65
+ /**
66
+ * @inheritDoc
67
+ */
68
+ init(): void;
69
+ /**
70
+ * Sets the active annotation for this UI.
71
+ */
72
+ setActiveAnnotation(annotation: Annotation | null): void;
73
+ /**
74
+ * @inheritDoc
75
+ */
76
+ attach(annotations: AnnotationCollection): void;
77
+ /**
78
+ * @inheritDoc
79
+ */
80
+ detach(): void;
81
+ /**
82
+ * @inheritDoc
83
+ */
84
+ override destroy(): void;
85
85
  }