@ckeditor/ckeditor5-comments 39.0.2 → 40.0.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.
- package/LICENSE.md +1 -1
- package/README.md +1 -1
- package/build/comments.js +1 -1
- package/build/translations/pt-br.js +1 -1
- package/lang/translations/pt-br.po +3 -3
- package/package.json +3 -3
- package/src/annotations/annotation.d.ts +90 -90
- package/src/annotations/annotation.js +1 -1
- package/src/annotations/annotationcollection.d.ts +98 -98
- package/src/annotations/annotationcollection.js +1 -1
- package/src/annotations/annotations.d.ts +154 -154
- package/src/annotations/annotations.js +1 -1
- package/src/annotations/annotationsuis.d.ts +232 -232
- package/src/annotations/annotationsuis.js +1 -1
- package/src/annotations/editorannotations.d.ts +67 -67
- package/src/annotations/editorannotations.js +1 -1
- package/src/annotations/inlineannotations.d.ts +90 -90
- package/src/annotations/inlineannotations.js +1 -1
- package/src/annotations/narrowsidebar.d.ts +85 -85
- package/src/annotations/narrowsidebar.js +1 -1
- package/src/annotations/sidebar.d.ts +100 -100
- package/src/annotations/sidebar.js +1 -1
- package/src/annotations/view/annotationcounterbuttonview.d.ts +29 -29
- package/src/annotations/view/annotationcounterbuttonview.js +1 -1
- package/src/annotations/view/annotationview.d.ts +90 -90
- package/src/annotations/view/annotationview.js +1 -1
- package/src/annotations/view/sidebaritemview.d.ts +55 -55
- package/src/annotations/view/sidebaritemview.js +1 -1
- package/src/annotations/view/sidebarview.d.ts +32 -32
- package/src/annotations/view/sidebarview.js +1 -1
- package/src/annotations/widesidebar.d.ts +77 -77
- package/src/annotations/widesidebar.js +1 -1
- package/src/augmentation.d.ts +52 -52
- package/src/comments/addcommentthreadcommand.d.ts +35 -35
- package/src/comments/addcommentthreadcommand.js +1 -1
- package/src/comments/commentsarchive.d.ts +31 -31
- package/src/comments/commentsarchive.js +1 -1
- package/src/comments/commentsarchiveui.d.ts +38 -38
- package/src/comments/commentsarchiveui.js +1 -1
- package/src/comments/commentsediting.d.ts +79 -79
- package/src/comments/commentsediting.js +1 -1
- package/src/comments/commentsrepository.d.ts +1129 -1105
- package/src/comments/commentsrepository.js +1 -1
- package/src/comments/commentsui.d.ts +33 -33
- package/src/comments/commentsui.js +1 -1
- package/src/comments/integrations/commentsrestrictededitingmode.d.ts +17 -17
- package/src/comments/integrations/commentsrestrictededitingmode.js +1 -1
- package/src/comments/integrations/importword.d.ts +21 -21
- package/src/comments/integrations/importword.js +1 -1
- package/src/comments/ui/commenteditor/commenteditor.d.ts +36 -36
- package/src/comments/ui/commenteditor/commenteditor.js +1 -1
- package/src/comments/ui/commenteditor/commenteditorui.d.ts +31 -31
- package/src/comments/ui/commenteditor/commenteditorui.js +1 -1
- package/src/comments/ui/commenteditor/commenteditoruiview.d.ts +36 -36
- package/src/comments/ui/commenteditor/commenteditoruiview.js +1 -1
- package/src/comments/ui/commentthreadcontroller.d.ts +64 -64
- package/src/comments/ui/commentthreadcontroller.js +1 -1
- package/src/comments/ui/view/basecommentthreadview.d.ts +119 -112
- package/src/comments/ui/view/basecommentthreadview.js +1 -1
- package/src/comments/ui/view/basecommentview.d.ts +112 -112
- package/src/comments/ui/view/basecommentview.js +1 -1
- package/src/comments/ui/view/collapsedcommentsview.d.ts +13 -13
- package/src/comments/ui/view/collapsedcommentsview.js +1 -1
- package/src/comments/ui/view/commentcontentview.d.ts +14 -14
- package/src/comments/ui/view/commentcontentview.js +1 -1
- package/src/comments/ui/view/commentinputview.d.ts +86 -86
- package/src/comments/ui/view/commentinputview.js +1 -1
- package/src/comments/ui/view/commentsarchiveview.d.ts +38 -38
- package/src/comments/ui/view/commentsarchiveview.js +1 -1
- package/src/comments/ui/view/commentslistview.d.ts +100 -100
- package/src/comments/ui/view/commentslistview.js +1 -1
- package/src/comments/ui/view/commentthreadheaderview.d.ts +50 -50
- package/src/comments/ui/view/commentthreadheaderview.js +1 -1
- package/src/comments/ui/view/commentthreadinputview.d.ts +41 -41
- package/src/comments/ui/view/commentthreadinputview.js +1 -1
- package/src/comments/ui/view/commentthreadview.d.ts +118 -117
- package/src/comments/ui/view/commentthreadview.js +1 -1
- package/src/comments/ui/view/commentview.d.ts +243 -243
- package/src/comments/ui/view/commentview.js +1 -1
- package/src/comments.d.ts +35 -35
- package/src/comments.js +1 -1
- package/src/commentsonly.d.ts +33 -33
- package/src/commentsonly.js +1 -1
- package/src/config.d.ts +176 -176
- package/src/index.d.ts +24 -24
- package/src/utils/common-translations.d.ts +9 -9
- package/src/utils/common-translations.js +1 -1
- package/src/utils/createmutationobserver.d.ts +14 -14
- package/src/utils/createmutationobserver.js +1 -1
- package/theme/annotation-inline.css +2 -1
- package/theme/annotation.css +2 -1
- package/theme/comment.css +2 -1
- package/theme/commentinput.css +2 -1
- package/theme/commentmarker.css +2 -1
- package/theme/commentsarchive.css +2 -1
- package/theme/commentthread.css +12 -1
- package/theme/icons/add-comment.svg +1 -1
- package/theme/icons/comments-archive.svg +1 -1
- package/theme/icons/edit-comment.svg +1 -1
- package/theme/icons/remove-comment.svg +1 -1
- package/theme/sidebar-narrow.css +2 -1
- package/theme/sidebar.css +2 -1
|
@@ -1,243 +1,243 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
-
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* @module comments/comments/ui/view/commentview
|
|
7
|
-
* @publicApi
|
|
8
|
-
*/
|
|
9
|
-
import { type Locale } from 'ckeditor5/src/utils';
|
|
10
|
-
import { ButtonView, type TemplateDefinition, type ViewCollection, type DropdownView } from 'ckeditor5/src/ui';
|
|
11
|
-
import { UserView } from 'ckeditor5-collaboration/src/collaboration-core';
|
|
12
|
-
import BaseCommentView from './basecommentview';
|
|
13
|
-
import type { Comment } from '../../commentsrepository';
|
|
14
|
-
import type CommentInputView from './commentinputview';
|
|
15
|
-
import type { CommentViewConfig } from '../../../config';
|
|
16
|
-
declare const CommentView_base: import("ckeditor5/src/utils").Mixed<typeof BaseCommentView, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin").ConfirmApi>;
|
|
17
|
-
/**
|
|
18
|
-
* The default view for comment.
|
|
19
|
-
*/
|
|
20
|
-
export default class CommentView extends CommentView_base {
|
|
21
|
-
locale: Locale;
|
|
22
|
-
isConfirm: boolean;
|
|
23
|
-
cancelConfirm: () => void;
|
|
24
|
-
showConfirm: (key: string, element: unknown) => Promise<void>;
|
|
25
|
-
/**
|
|
26
|
-
* A property used by the template.
|
|
27
|
-
*
|
|
28
|
-
* It works as a visual indicator for the user that an action is about to be performed.
|
|
29
|
-
* The value of this property is used in setting the CSS class.
|
|
30
|
-
* The property is used when the user interacts with the view.
|
|
31
|
-
*
|
|
32
|
-
* @observable
|
|
33
|
-
*/
|
|
34
|
-
actionIndicator: string | null;
|
|
35
|
-
/**
|
|
36
|
-
* Comment editor placeholder value.
|
|
37
|
-
*
|
|
38
|
-
* @observable
|
|
39
|
-
*/
|
|
40
|
-
placeholder: string;
|
|
41
|
-
/**
|
|
42
|
-
* Comment creation date.
|
|
43
|
-
*
|
|
44
|
-
* @observable
|
|
45
|
-
*/
|
|
46
|
-
authoredAt: Date;
|
|
47
|
-
/**
|
|
48
|
-
* Comment resolved date.
|
|
49
|
-
*
|
|
50
|
-
* @observable
|
|
51
|
-
*/
|
|
52
|
-
resolvedAt: Date | null;
|
|
53
|
-
/**
|
|
54
|
-
* Collection for UI elements that manage the comment.
|
|
55
|
-
*
|
|
56
|
-
* Elements that may be found in the action bar (depending on the comment view properties):
|
|
57
|
-
*
|
|
58
|
-
* * the resolve comment thread button (only if the comment is the first comment),
|
|
59
|
-
* * a dropdown with actions ({@link ~CommentView#dropdown `dropdown`}).
|
|
60
|
-
*/
|
|
61
|
-
actionBar: ViewCollection;
|
|
62
|
-
/**
|
|
63
|
-
* View collection which holds all the comments dropdown elements.
|
|
64
|
-
*
|
|
65
|
-
* May include, depending on the view properties:
|
|
66
|
-
*
|
|
67
|
-
* * {@link ~CommentView#editButton `editButton`},
|
|
68
|
-
* * {@link ~CommentView#removeButton `removeButton`}.
|
|
69
|
-
*/
|
|
70
|
-
items: ViewCollection<ButtonView>;
|
|
71
|
-
/**
|
|
72
|
-
* Dropdown containing comment action buttons defined in {@link ~CommentView#items `items`}.
|
|
73
|
-
*/
|
|
74
|
-
dropdown: DropdownView;
|
|
75
|
-
/**
|
|
76
|
-
* Edit button view. Edit button switches the comment to the editing mode.
|
|
77
|
-
*/
|
|
78
|
-
editButton: ButtonView;
|
|
79
|
-
/**
|
|
80
|
-
* Remove button view. Remove button shows a confirmation box that fires the `removeComment` event when submitted.
|
|
81
|
-
*/
|
|
82
|
-
removeButton: ButtonView;
|
|
83
|
-
/**
|
|
84
|
-
* User view for the comment. Presents the comment author.
|
|
85
|
-
*/
|
|
86
|
-
userView: UserView;
|
|
87
|
-
/**
|
|
88
|
-
* @inheritDoc
|
|
89
|
-
*/
|
|
90
|
-
constructor(locale: Locale, model: Comment, config: CommentViewConfig);
|
|
91
|
-
/**
|
|
92
|
-
* Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
|
|
93
|
-
*
|
|
94
|
-
* Overwrite this method if you want to set a custom template for the comment view.
|
|
95
|
-
*
|
|
96
|
-
* The default template looks as follows:
|
|
97
|
-
*
|
|
98
|
-
* ```ts
|
|
99
|
-
* const bind = this.bindTemplate;
|
|
100
|
-
*
|
|
101
|
-
* {
|
|
102
|
-
* tag: 'li',
|
|
103
|
-
*
|
|
104
|
-
* attributes: {
|
|
105
|
-
* class: [
|
|
106
|
-
* 'ck-comment__wrapper',
|
|
107
|
-
* bind.if( 'isConfirm', 'ck-comment--remove-confirmation' )
|
|
108
|
-
* ],
|
|
109
|
-
* tabindex: -1
|
|
110
|
-
* },
|
|
111
|
-
*
|
|
112
|
-
* children: [
|
|
113
|
-
* {
|
|
114
|
-
* tag: 'div',
|
|
115
|
-
*
|
|
116
|
-
* attributes: {
|
|
117
|
-
* class: [
|
|
118
|
-
* 'ck-comment',
|
|
119
|
-
* 'ck-annotation',
|
|
120
|
-
* bind.if( 'isSystemComment', 'ck-comment--info' ),
|
|
121
|
-
* bind.if( 'isEditMode', 'ck-comment--edit' ),
|
|
122
|
-
* bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
|
|
123
|
-
* ],
|
|
124
|
-
* 'data-author-id': this._model.author.id,
|
|
125
|
-
* 'data-comment-id': this._model.id
|
|
126
|
-
* },
|
|
127
|
-
*
|
|
128
|
-
* children: [
|
|
129
|
-
* this.userView,
|
|
130
|
-
* {
|
|
131
|
-
* tag: 'div',
|
|
132
|
-
*
|
|
133
|
-
* attributes: {
|
|
134
|
-
* class: [ 'ck-comment__main', 'ck-annotation__main' ]
|
|
135
|
-
* },
|
|
136
|
-
*
|
|
137
|
-
* children: [
|
|
138
|
-
* {
|
|
139
|
-
* tag: 'div',
|
|
140
|
-
*
|
|
141
|
-
* attributes: {
|
|
142
|
-
* class: [ 'ck-comment__info', 'ck-annotation__info' ]
|
|
143
|
-
* },
|
|
144
|
-
*
|
|
145
|
-
* children: [
|
|
146
|
-
* {
|
|
147
|
-
* tag: 'span',
|
|
148
|
-
*
|
|
149
|
-
* children: [
|
|
150
|
-
* {
|
|
151
|
-
* text: this.userView.name
|
|
152
|
-
* }
|
|
153
|
-
* ],
|
|
154
|
-
*
|
|
155
|
-
* attributes: {
|
|
156
|
-
* class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
|
|
157
|
-
* }
|
|
158
|
-
* },
|
|
159
|
-
* {
|
|
160
|
-
* tag: 'time',
|
|
161
|
-
*
|
|
162
|
-
* attributes: {
|
|
163
|
-
* datetime: bind.to( 'authoredAt' ),
|
|
164
|
-
* class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
|
|
165
|
-
* },
|
|
166
|
-
*
|
|
167
|
-
* children: [
|
|
168
|
-
* {
|
|
169
|
-
* text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
|
|
170
|
-
* }
|
|
171
|
-
* ]
|
|
172
|
-
* }
|
|
173
|
-
* ]
|
|
174
|
-
* },
|
|
175
|
-
* {
|
|
176
|
-
* tag: 'div',
|
|
177
|
-
*
|
|
178
|
-
* attributes: {
|
|
179
|
-
* class: [
|
|
180
|
-
* 'ck-comment__actions',
|
|
181
|
-
* 'ck-annotation__actions',
|
|
182
|
-
* bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
|
|
183
|
-
* bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
|
|
184
|
-
* ]
|
|
185
|
-
* },
|
|
186
|
-
*
|
|
187
|
-
* children: this.actionBar
|
|
188
|
-
* },
|
|
189
|
-
* {
|
|
190
|
-
* tag: 'div',
|
|
191
|
-
*
|
|
192
|
-
* attributes: {
|
|
193
|
-
* class: [ 'ck-annotation__content-wrapper' ]
|
|
194
|
-
* },
|
|
195
|
-
*
|
|
196
|
-
* children: this.visibleView
|
|
197
|
-
* },
|
|
198
|
-
* {
|
|
199
|
-
* tag: 'div',
|
|
200
|
-
*
|
|
201
|
-
* attributes: {
|
|
202
|
-
* class: [ 'ck-comment__external' ]
|
|
203
|
-
* },
|
|
204
|
-
*
|
|
205
|
-
* children: [ {
|
|
206
|
-
* text: this.getExternalCommentNote()
|
|
207
|
-
* } ]
|
|
208
|
-
* }
|
|
209
|
-
* ]
|
|
210
|
-
* }
|
|
211
|
-
*
|
|
212
|
-
* ]
|
|
213
|
-
* }
|
|
214
|
-
* ]
|
|
215
|
-
* }
|
|
216
|
-
* ```
|
|
217
|
-
*
|
|
218
|
-
* @returns Definition of comment thread view's template.
|
|
219
|
-
*/
|
|
220
|
-
getTemplate(): TemplateDefinition;
|
|
221
|
-
/**
|
|
222
|
-
* @inheritDoc
|
|
223
|
-
*/
|
|
224
|
-
protected _createCommentInputView(): CommentInputView;
|
|
225
|
-
/**
|
|
226
|
-
* Gets the translated note which indicates that the comment comes from an external source.
|
|
227
|
-
*/
|
|
228
|
-
getExternalCommentNote(): string;
|
|
229
|
-
/**
|
|
230
|
-
* Gets the translated notification text which indicates that author name comes from an external source.
|
|
231
|
-
*/
|
|
232
|
-
getUserViewNotificationText(): string | null;
|
|
233
|
-
/**
|
|
234
|
-
* @inheritDoc
|
|
235
|
-
*/
|
|
236
|
-
render(): void;
|
|
237
|
-
}
|
|
238
|
-
declare module 'ckeditor5/src/ui' {
|
|
239
|
-
interface DropdownView {
|
|
240
|
-
isVisible: boolean;
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
export {};
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @module comments/comments/ui/view/commentview
|
|
7
|
+
* @publicApi
|
|
8
|
+
*/
|
|
9
|
+
import { type Locale } from 'ckeditor5/src/utils';
|
|
10
|
+
import { ButtonView, type TemplateDefinition, type ViewCollection, type DropdownView } from 'ckeditor5/src/ui';
|
|
11
|
+
import { UserView } from 'ckeditor5-collaboration/src/collaboration-core';
|
|
12
|
+
import BaseCommentView from './basecommentview';
|
|
13
|
+
import type { Comment } from '../../commentsrepository';
|
|
14
|
+
import type CommentInputView from './commentinputview';
|
|
15
|
+
import type { CommentViewConfig } from '../../../config';
|
|
16
|
+
declare const CommentView_base: import("ckeditor5/src/utils").Mixed<typeof BaseCommentView, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin").ConfirmApi>;
|
|
17
|
+
/**
|
|
18
|
+
* The default view for comment.
|
|
19
|
+
*/
|
|
20
|
+
export default class CommentView extends CommentView_base {
|
|
21
|
+
locale: Locale;
|
|
22
|
+
isConfirm: boolean;
|
|
23
|
+
cancelConfirm: () => void;
|
|
24
|
+
showConfirm: (key: string, element: unknown) => Promise<void>;
|
|
25
|
+
/**
|
|
26
|
+
* A property used by the template.
|
|
27
|
+
*
|
|
28
|
+
* It works as a visual indicator for the user that an action is about to be performed.
|
|
29
|
+
* The value of this property is used in setting the CSS class.
|
|
30
|
+
* The property is used when the user interacts with the view.
|
|
31
|
+
*
|
|
32
|
+
* @observable
|
|
33
|
+
*/
|
|
34
|
+
actionIndicator: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* Comment editor placeholder value.
|
|
37
|
+
*
|
|
38
|
+
* @observable
|
|
39
|
+
*/
|
|
40
|
+
placeholder: string;
|
|
41
|
+
/**
|
|
42
|
+
* Comment creation date.
|
|
43
|
+
*
|
|
44
|
+
* @observable
|
|
45
|
+
*/
|
|
46
|
+
authoredAt: Date;
|
|
47
|
+
/**
|
|
48
|
+
* Comment resolved date.
|
|
49
|
+
*
|
|
50
|
+
* @observable
|
|
51
|
+
*/
|
|
52
|
+
resolvedAt: Date | null;
|
|
53
|
+
/**
|
|
54
|
+
* Collection for UI elements that manage the comment.
|
|
55
|
+
*
|
|
56
|
+
* Elements that may be found in the action bar (depending on the comment view properties):
|
|
57
|
+
*
|
|
58
|
+
* * the resolve comment thread button (only if the comment is the first comment),
|
|
59
|
+
* * a dropdown with actions ({@link ~CommentView#dropdown `dropdown`}).
|
|
60
|
+
*/
|
|
61
|
+
actionBar: ViewCollection;
|
|
62
|
+
/**
|
|
63
|
+
* View collection which holds all the comments dropdown elements.
|
|
64
|
+
*
|
|
65
|
+
* May include, depending on the view properties:
|
|
66
|
+
*
|
|
67
|
+
* * {@link ~CommentView#editButton `editButton`},
|
|
68
|
+
* * {@link ~CommentView#removeButton `removeButton`}.
|
|
69
|
+
*/
|
|
70
|
+
items: ViewCollection<ButtonView>;
|
|
71
|
+
/**
|
|
72
|
+
* Dropdown containing comment action buttons defined in {@link ~CommentView#items `items`}.
|
|
73
|
+
*/
|
|
74
|
+
dropdown: DropdownView;
|
|
75
|
+
/**
|
|
76
|
+
* Edit button view. Edit button switches the comment to the editing mode.
|
|
77
|
+
*/
|
|
78
|
+
editButton: ButtonView;
|
|
79
|
+
/**
|
|
80
|
+
* Remove button view. Remove button shows a confirmation box that fires the `removeComment` event when submitted.
|
|
81
|
+
*/
|
|
82
|
+
removeButton: ButtonView;
|
|
83
|
+
/**
|
|
84
|
+
* User view for the comment. Presents the comment author.
|
|
85
|
+
*/
|
|
86
|
+
userView: UserView;
|
|
87
|
+
/**
|
|
88
|
+
* @inheritDoc
|
|
89
|
+
*/
|
|
90
|
+
constructor(locale: Locale, model: Comment, config: CommentViewConfig);
|
|
91
|
+
/**
|
|
92
|
+
* Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
|
|
93
|
+
*
|
|
94
|
+
* Overwrite this method if you want to set a custom template for the comment view.
|
|
95
|
+
*
|
|
96
|
+
* The default template looks as follows:
|
|
97
|
+
*
|
|
98
|
+
* ```ts
|
|
99
|
+
* const bind = this.bindTemplate;
|
|
100
|
+
*
|
|
101
|
+
* {
|
|
102
|
+
* tag: 'li',
|
|
103
|
+
*
|
|
104
|
+
* attributes: {
|
|
105
|
+
* class: [
|
|
106
|
+
* 'ck-comment__wrapper',
|
|
107
|
+
* bind.if( 'isConfirm', 'ck-comment--remove-confirmation' )
|
|
108
|
+
* ],
|
|
109
|
+
* tabindex: -1
|
|
110
|
+
* },
|
|
111
|
+
*
|
|
112
|
+
* children: [
|
|
113
|
+
* {
|
|
114
|
+
* tag: 'div',
|
|
115
|
+
*
|
|
116
|
+
* attributes: {
|
|
117
|
+
* class: [
|
|
118
|
+
* 'ck-comment',
|
|
119
|
+
* 'ck-annotation',
|
|
120
|
+
* bind.if( 'isSystemComment', 'ck-comment--info' ),
|
|
121
|
+
* bind.if( 'isEditMode', 'ck-comment--edit' ),
|
|
122
|
+
* bind.to( 'actionIndicator', value => value ? `ck-comment--${ value }` : '' )
|
|
123
|
+
* ],
|
|
124
|
+
* 'data-author-id': this._model.author.id,
|
|
125
|
+
* 'data-comment-id': this._model.id
|
|
126
|
+
* },
|
|
127
|
+
*
|
|
128
|
+
* children: [
|
|
129
|
+
* this.userView,
|
|
130
|
+
* {
|
|
131
|
+
* tag: 'div',
|
|
132
|
+
*
|
|
133
|
+
* attributes: {
|
|
134
|
+
* class: [ 'ck-comment__main', 'ck-annotation__main' ]
|
|
135
|
+
* },
|
|
136
|
+
*
|
|
137
|
+
* children: [
|
|
138
|
+
* {
|
|
139
|
+
* tag: 'div',
|
|
140
|
+
*
|
|
141
|
+
* attributes: {
|
|
142
|
+
* class: [ 'ck-comment__info', 'ck-annotation__info' ]
|
|
143
|
+
* },
|
|
144
|
+
*
|
|
145
|
+
* children: [
|
|
146
|
+
* {
|
|
147
|
+
* tag: 'span',
|
|
148
|
+
*
|
|
149
|
+
* children: [
|
|
150
|
+
* {
|
|
151
|
+
* text: this.userView.name
|
|
152
|
+
* }
|
|
153
|
+
* ],
|
|
154
|
+
*
|
|
155
|
+
* attributes: {
|
|
156
|
+
* class: [ 'ck-comment__info-name', 'ck-annotation__info-name' ]
|
|
157
|
+
* }
|
|
158
|
+
* },
|
|
159
|
+
* {
|
|
160
|
+
* tag: 'time',
|
|
161
|
+
*
|
|
162
|
+
* attributes: {
|
|
163
|
+
* datetime: bind.to( 'authoredAt' ),
|
|
164
|
+
* class: [ 'ck-comment__info-time', 'ck-annotation__info-time' ]
|
|
165
|
+
* },
|
|
166
|
+
*
|
|
167
|
+
* children: [
|
|
168
|
+
* {
|
|
169
|
+
* text: bind.to( 'authoredAt', value => this._config.formatDateTime( value ) )
|
|
170
|
+
* }
|
|
171
|
+
* ]
|
|
172
|
+
* }
|
|
173
|
+
* ]
|
|
174
|
+
* },
|
|
175
|
+
* {
|
|
176
|
+
* tag: 'div',
|
|
177
|
+
*
|
|
178
|
+
* attributes: {
|
|
179
|
+
* class: [
|
|
180
|
+
* 'ck-comment__actions',
|
|
181
|
+
* 'ck-annotation__actions',
|
|
182
|
+
* bind.if( 'isEditMode', 'ck-comment__actions--hidden' ),
|
|
183
|
+
* bind.if( 'isEditMode', 'ck-annotation__actions--hidden' )
|
|
184
|
+
* ]
|
|
185
|
+
* },
|
|
186
|
+
*
|
|
187
|
+
* children: this.actionBar
|
|
188
|
+
* },
|
|
189
|
+
* {
|
|
190
|
+
* tag: 'div',
|
|
191
|
+
*
|
|
192
|
+
* attributes: {
|
|
193
|
+
* class: [ 'ck-annotation__content-wrapper' ]
|
|
194
|
+
* },
|
|
195
|
+
*
|
|
196
|
+
* children: this.visibleView
|
|
197
|
+
* },
|
|
198
|
+
* {
|
|
199
|
+
* tag: 'div',
|
|
200
|
+
*
|
|
201
|
+
* attributes: {
|
|
202
|
+
* class: [ 'ck-comment__external' ]
|
|
203
|
+
* },
|
|
204
|
+
*
|
|
205
|
+
* children: [ {
|
|
206
|
+
* text: this.getExternalCommentNote()
|
|
207
|
+
* } ]
|
|
208
|
+
* }
|
|
209
|
+
* ]
|
|
210
|
+
* }
|
|
211
|
+
*
|
|
212
|
+
* ]
|
|
213
|
+
* }
|
|
214
|
+
* ]
|
|
215
|
+
* }
|
|
216
|
+
* ```
|
|
217
|
+
*
|
|
218
|
+
* @returns Definition of comment thread view's template.
|
|
219
|
+
*/
|
|
220
|
+
getTemplate(): TemplateDefinition;
|
|
221
|
+
/**
|
|
222
|
+
* @inheritDoc
|
|
223
|
+
*/
|
|
224
|
+
protected _createCommentInputView(): CommentInputView;
|
|
225
|
+
/**
|
|
226
|
+
* Gets the translated note which indicates that the comment comes from an external source.
|
|
227
|
+
*/
|
|
228
|
+
getExternalCommentNote(): string;
|
|
229
|
+
/**
|
|
230
|
+
* Gets the translated notification text which indicates that author name comes from an external source.
|
|
231
|
+
*/
|
|
232
|
+
getUserViewNotificationText(): string | null;
|
|
233
|
+
/**
|
|
234
|
+
* @inheritDoc
|
|
235
|
+
*/
|
|
236
|
+
render(): void;
|
|
237
|
+
}
|
|
238
|
+
declare module 'ckeditor5/src/ui' {
|
|
239
|
+
interface DropdownView {
|
|
240
|
+
isVisible: boolean;
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
const
|
|
23
|
+
const _0x5116=['time','Edit','_createCommentInputView','resolvedAt','ck-comment--','authoredAt','blur','set','EXTERNAL_IMPORT_WORD_COMMENT','some','showConfirm','isEditable','author','EXTERNAL_IMPORT_WORD_AVATAR','importWord','ck-comment__actions','ck-comment__user','_attachActions','isExternal','actionIndicator','ck-annotation__info-name','dropdown','change:isRemovable','element','ck-annotation__actions','createCollection','name','panelPosition','extendTemplate','mouseenter','children','ck-annotation__info','execute','ck-comment__external','bind','setTemplate','source','_createEditButton','ck-comment__main','items','getExternalCommentNote','formatDateTime','creator','visibleView','cancelConfirm','_model','ck-comment--edit','add','placeholder','ck-comment--remove','change:isVisible','then','edit','remove','label','isEditMode','isSystemComment','_createDropdown','push','ck-comment__actions--hidden','ck-annotation','getTemplate','listenTo','withText','switchToEditMode','fire','render','isEnabled','EXTERNAL_AVATAR','getUserViewNotificationText','length','isVisible','EXTERNAL_COMMENT','mouseleave','ck-annotation__main','ck-comment--remove-confirmation','attributes','editButton','Remove','isReadOnly','buttonView','bindTemplate','Reply...','actionBar','userView','div','_createRemoveButton','ck-comment__info','_config','locale','ck-comment--info','ck-annotation__content-wrapper','isConfirm'];(function(_0x37ecc2,_0x511694){const _0x1446a7=function(_0x52836b){while(--_0x52836b){_0x37ecc2['push'](_0x37ecc2['shift']());}};_0x1446a7(++_0x511694);}(_0x5116,0x14f));const _0x1446=function(_0x37ecc2,_0x511694){_0x37ecc2=_0x37ecc2-0x0;let _0x1446a7=_0x5116[_0x37ecc2];return _0x1446a7;};import{ButtonView as _0x5a8506,createDropdown as _0xd5ce0c,ListView as _0x2b84af,ListItemView as _0x19f775}from'ckeditor5/src/ui';import{icons as _0x20b364}from'ckeditor5/src/core';import{UserView as _0x301523,ConfirmMixin as _0x940c4e}from'ckeditor5-collaboration/src/collaboration-core';import _0x560ac9 from'./basecommentview';import _0x3e1615 from'../../../../theme/icons/remove-comment.svg';import{getTranslation as _0x1b01f0}from'../../../utils/common-translations';export default class ut extends _0x940c4e(_0x560ac9){constructor(_0x1e54a3,_0x561b19,_0x4824b3){super(_0x1e54a3,_0x561b19,_0x4824b3),this[_0x1446('0x2c')](_0x1446('0x38'),null),this['set']('placeholder',_0x1b01f0(_0x1e54a3,_0x1446('0x1a'))),this[_0x1446('0x47')]('authoredAt')['to'](_0x561b19),this[_0x1446('0x47')](_0x1446('0x28'))['to'](_0x561b19),this[_0x1446('0x1b')]=this['createCollection'](),this[_0x1446('0x0')]||(this[_0x1446('0x15')]=this['_createEditButton'](),this['removeButton']=this[_0x1446('0x1e')](),this['items']=this[_0x1446('0x3e')](),this['items']['addMany']([this[_0x1446('0x15')],this['removeButton']]),this[_0x1446('0x3a')]=this[_0x1446('0x1')](),this[_0x1446('0x1b')][_0x1446('0x54')](this[_0x1446('0x3a')])),this[_0x1446('0x1c')]=new _0x301523(_0x1e54a3,_0x561b19[_0x1446('0x31')],this[_0x1446('0xd')]()),this[_0x1446('0x1c')][_0x1446('0x41')]({'attributes':{'class':[_0x1446('0x35'),'ck-annotation__user']}}),this[_0x1446('0x6')](_0x561b19,_0x1446('0x3b'),()=>this[_0x1446('0x51')]()),this[_0x1446('0x48')](this[_0x1446('0x5')]());}[_0x1446('0x5')](){const _0x3818ae=this[_0x1446('0x19')],_0x47baa4=[{'tag':_0x1446('0x1d'),'attributes':{'class':[_0x1446('0x1f'),_0x1446('0x44')]},'children':[{'tag':'span','children':[{'text':this['userView'][_0x1446('0x3f')]}],'attributes':{'class':['ck-comment__info-name',_0x1446('0x39')]}},{'tag':_0x1446('0x25'),'attributes':{'datetime':_0x3818ae['to'](_0x1446('0x2a')),'class':['ck-comment__info-time','ck-annotation__info-time']},'children':[{'text':_0x3818ae['to'](_0x1446('0x2a'),_0x3803cc=>this[_0x1446('0x20')][_0x1446('0x4e')](_0x3803cc))}]}]},{'tag':_0x1446('0x1d'),'attributes':{'class':[_0x1446('0x34'),_0x1446('0x3d'),_0x3818ae['if'](_0x1446('0x5c'),_0x1446('0x3')),_0x3818ae['if']('isEditMode','ck-annotation__actions--hidden')]},'children':this[_0x1446('0x1b')]},{'tag':'div','attributes':{'class':[_0x1446('0x23')]},'children':this[_0x1446('0x50')]}];return this['_model'][_0x1446('0x37')]&&_0x47baa4[_0x1446('0x2')]({'tag':_0x1446('0x1d'),'attributes':{'class':[_0x1446('0x46')]},'children':[{'text':this[_0x1446('0x4d')]()}]}),{'tag':'li','attributes':{'class':['ck-comment__wrapper',_0x3818ae['if'](_0x1446('0x24'),_0x1446('0x13'))],'tabindex':-0x1},'children':[{'tag':_0x1446('0x1d'),'attributes':{'class':['ck-comment',_0x1446('0x4'),_0x3818ae['if']('isEditMode',_0x1446('0x53')),_0x3818ae['if'](_0x1446('0x0'),_0x1446('0x22')),_0x3818ae['to'](_0x1446('0x38'),_0x4e020c=>_0x4e020c?_0x1446('0x29')+_0x4e020c:'')],'data-author-id':this[_0x1446('0x52')]['author']['id'],'data-comment-id':this[_0x1446('0x52')]['id']},'children':[this[_0x1446('0x1c')],{'tag':'div','attributes':{'class':[_0x1446('0x4b'),_0x1446('0x12')]},'children':_0x47baa4}]}]};}[_0x1446('0x4a')](){const _0x1285e7=new _0x5a8506(this['locale']);return _0x1285e7[_0x1446('0x5b')]=_0x1b01f0(this[_0x1446('0x21')],_0x1446('0x26')),_0x1285e7['icon']=_0x20b364['pencil'],_0x1285e7['withText']=!0x0,_0x1285e7['extendTemplate']({'attributes':{'class':_0x1446('0x53')}}),_0x1285e7[_0x1446('0x47')](_0x1446('0xb'))['to'](this[_0x1446('0x52')],_0x1446('0x17'),_0x3c131b=>!_0x3c131b),_0x1285e7[_0x1446('0x47')](_0x1446('0xf'))['to'](this[_0x1446('0x52')],_0x1446('0x30')),_0x1285e7['on'](_0x1446('0x45'),()=>this[_0x1446('0x8')]()),_0x1285e7;}[_0x1446('0x1e')](){const _0x801b30=new _0x5a8506(this[_0x1446('0x21')]);return _0x801b30['label']=_0x1b01f0(this[_0x1446('0x21')],_0x1446('0x16')),_0x801b30['icon']=_0x3e1615,_0x801b30[_0x1446('0x7')]=!0x0,_0x801b30['extendTemplate']({'attributes':{'class':_0x1446('0x56')}}),_0x801b30[_0x1446('0x47')](_0x1446('0xb'))['to'](this['_model'],_0x1446('0x17'),_0x2a5461=>!_0x2a5461),_0x801b30[_0x1446('0x47')](_0x1446('0xf'))['to'](this[_0x1446('0x52')],'isRemovable'),_0x801b30['on'](_0x1446('0x45'),()=>{this[_0x1446('0x2f')](_0x1b01f0(this[_0x1446('0x21')],'Delete\x20comment?'),this[_0x1446('0x3c')])[_0x1446('0x58')](()=>{this[_0x1446('0x9')]('removeComment',this['_model']['id']);});}),_0x801b30;}[_0x1446('0x1')](){const _0x285e52=_0xd5ce0c(this[_0x1446('0x21')]),_0x5035ff=_0x285e52['panelView'][_0x1446('0x43')],_0xf02dd4=new _0x2b84af(this[_0x1446('0x21')]),_0x507d39=(_0x250849,_0x4768ff=-0x1)=>{const _0x36892c=new _0x19f775(this[_0x1446('0x21')]);_0x36892c[_0x1446('0x43')][_0x1446('0x54')](_0x250849);const _0x574da4=_0x4768ff>-0x1?_0x4768ff:_0xf02dd4['items'][_0x1446('0xe')];_0xf02dd4[_0x1446('0x4c')]['add'](_0x36892c,_0x574da4),_0x285e52[_0x1446('0x6')](_0x250849,'change:isEnabled',()=>{_0x285e52[_0x1446('0xb')]=[...this[_0x1446('0x4c')]][_0x1446('0x2e')](_0x1c23ac=>_0x1c23ac[_0x1446('0xb')]);}),_0x285e52[_0x1446('0x6')](_0x250849,_0x1446('0x57'),()=>{_0x285e52['buttonView']['isVisible']=[...this[_0x1446('0x4c')]][_0x1446('0x2e')](_0x174d02=>_0x174d02['isVisible']);});};_0x285e52[_0x1446('0x40')]='sw',_0x285e52[_0x1446('0x18')][_0x1446('0x2c')]({'label':_0x1b01f0(this['locale'],'Show\x20more\x20items'),'icon':_0x20b364['threeVerticalDots']}),_0x285e52['isEnabled']=[...this[_0x1446('0x4c')]][_0x1446('0x2e')](_0x52e2a2=>_0x52e2a2[_0x1446('0xb')]),_0x285e52['buttonView'][_0x1446('0xf')]=[...this['items']][_0x1446('0x2e')](_0x5512f2=>_0x5512f2['isVisible']);for(const _0x38ece3 of this['items'])_0x507d39(_0x38ece3);return _0x5035ff[_0x1446('0x54')](_0xf02dd4),_0x285e52['listenTo'](this[_0x1446('0x4c')],_0x1446('0x54'),(_0x2bd470,_0xe8650b,_0x5d891c)=>{_0x507d39(_0xe8650b,_0x5d891c);}),_0x285e52['listenTo'](this['items'],_0x1446('0x5a'),(_0x46d816,_0x5e3f99,_0x44eb1d)=>{_0xf02dd4[_0x1446('0x4c')][_0x1446('0x5a')](_0x44eb1d);}),_0x285e52;}[_0x1446('0x36')](_0x138b01,_0x3f4038){const _0x23f9f4=_0x138b01&&_0x138b01['element'];_0x23f9f4&&(this[_0x1446('0x6')](_0x23f9f4,_0x1446('0x42'),()=>this[_0x1446('0x38')]=_0x3f4038),this[_0x1446('0x6')](_0x23f9f4,'focus',()=>this['actionIndicator']=_0x3f4038),this[_0x1446('0x6')](_0x23f9f4,_0x1446('0x11'),()=>this[_0x1446('0x38')]=null),this['listenTo'](_0x23f9f4,_0x1446('0x2b'),()=>this[_0x1446('0x38')]=null));}[_0x1446('0x27')](){const _0xf13ca9=super[_0x1446('0x27')]();return _0xf13ca9[_0x1446('0x47')](_0x1446('0x55'))['to'](this),_0xf13ca9;}[_0x1446('0x4d')](){return _0x1446('0x33')===this[_0x1446('0x52')][_0x1446('0x14')]['@external'][_0x1446('0x49')]?_0x1b01f0(this['locale'],_0x1446('0x2d')):_0x1b01f0(this[_0x1446('0x21')],_0x1446('0x10'));}[_0x1446('0xd')](){return this['_model']['isExternal']?_0x1446('0x33')===this[_0x1446('0x52')][_0x1446('0x14')]['@external'][_0x1446('0x49')]?_0x1b01f0(this['locale'],_0x1446('0x32'),this[_0x1446('0x52')][_0x1446('0x4f')][_0x1446('0x3f')]):_0x1b01f0(this[_0x1446('0x21')],_0x1446('0xc'),this['_model'][_0x1446('0x4f')][_0x1446('0x3f')]):null;}[_0x1446('0xa')](){super[_0x1446('0xa')](),this['_attachActions'](this['editButton'],_0x1446('0x59')),this[_0x1446('0x36')](this['removeButton'],_0x1446('0x5a'));}}
|
package/src/comments.d.ts
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
-
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* @module comments/comments
|
|
7
|
-
* @publicApi
|
|
8
|
-
*/
|
|
9
|
-
import { Plugin } from 'ckeditor5/src/core';
|
|
10
|
-
import CommentsRepository from './comments/commentsrepository';
|
|
11
|
-
import CommentsEditing from './comments/commentsediting';
|
|
12
|
-
import CommentsUI from './comments/commentsui';
|
|
13
|
-
import CommentsOnly from './commentsonly';
|
|
14
|
-
import WideSidebar from './annotations/widesidebar';
|
|
15
|
-
import NarrowSidebar from './annotations/narrowsidebar';
|
|
16
|
-
import InlineAnnotations from './annotations/inlineannotations';
|
|
17
|
-
import CommentsArchiveUI from './comments/commentsarchiveui';
|
|
18
|
-
import CommentsArchive from './comments/commentsarchive';
|
|
19
|
-
/**
|
|
20
|
-
* The comments plugin, which brings both the UI part and the editing part of this feature.
|
|
21
|
-
*
|
|
22
|
-
* It registers {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand the `AddCommentThreadCommand` command}.
|
|
23
|
-
*
|
|
24
|
-
* To learn more about the comments feature refer to the {@glink features/collaboration/comments/comments Comments} guide.
|
|
25
|
-
*/
|
|
26
|
-
export default class Comments extends Plugin {
|
|
27
|
-
/**
|
|
28
|
-
* @inheritDoc
|
|
29
|
-
*/
|
|
30
|
-
static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof CommentsUI, typeof CommentsArchive, typeof CommentsArchiveUI, typeof CommentsOnly, typeof WideSidebar, typeof NarrowSidebar, typeof InlineAnnotations];
|
|
31
|
-
/**
|
|
32
|
-
* @inheritDoc
|
|
33
|
-
*/
|
|
34
|
-
static get pluginName(): "Comments";
|
|
35
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @module comments/comments
|
|
7
|
+
* @publicApi
|
|
8
|
+
*/
|
|
9
|
+
import { Plugin } from 'ckeditor5/src/core';
|
|
10
|
+
import CommentsRepository from './comments/commentsrepository';
|
|
11
|
+
import CommentsEditing from './comments/commentsediting';
|
|
12
|
+
import CommentsUI from './comments/commentsui';
|
|
13
|
+
import CommentsOnly from './commentsonly';
|
|
14
|
+
import WideSidebar from './annotations/widesidebar';
|
|
15
|
+
import NarrowSidebar from './annotations/narrowsidebar';
|
|
16
|
+
import InlineAnnotations from './annotations/inlineannotations';
|
|
17
|
+
import CommentsArchiveUI from './comments/commentsarchiveui';
|
|
18
|
+
import CommentsArchive from './comments/commentsarchive';
|
|
19
|
+
/**
|
|
20
|
+
* The comments plugin, which brings both the UI part and the editing part of this feature.
|
|
21
|
+
*
|
|
22
|
+
* It registers {@link module:comments/comments/addcommentthreadcommand~AddCommentThreadCommand the `AddCommentThreadCommand` command}.
|
|
23
|
+
*
|
|
24
|
+
* To learn more about the comments feature refer to the {@glink features/collaboration/comments/comments Comments} guide.
|
|
25
|
+
*/
|
|
26
|
+
export default class Comments extends Plugin {
|
|
27
|
+
/**
|
|
28
|
+
* @inheritDoc
|
|
29
|
+
*/
|
|
30
|
+
static get requires(): readonly [typeof CommentsRepository, typeof CommentsEditing, typeof CommentsUI, typeof CommentsArchive, typeof CommentsArchiveUI, typeof CommentsOnly, typeof WideSidebar, typeof NarrowSidebar, typeof InlineAnnotations];
|
|
31
|
+
/**
|
|
32
|
+
* @inheritDoc
|
|
33
|
+
*/
|
|
34
|
+
static get pluginName(): "Comments";
|
|
35
|
+
}
|