@@ -653,7 +653,7 @@ Configuration for text formatting toolbar options in comment composers.
653653| -------------------- | --------------------- | -------- | -------------------------------------------- |
654654| `editor` | `Editor` | Yes | Slate editor instance. |
655655| `editorId` | `string` | No | Optional editor ID used to scope operations. |
656- | `commentAnnotations` | `CommentAnnotation[]` | No | Annotations to render/highlight. |
656+ | `commentAnnotations` | [ `CommentAnnotation`](#commentannotation)` []` | No | Annotations to render/highlight. |
657657
658658For the CommentAnnotation model referenced above, see [CommentAnnotation](#commentannotation).
659659
@@ -1176,6 +1176,78 @@ Nested in `CommentAnnotationContext`.
11761176| `occurrence` | `number` | Yes | The 1-based occurrence index of the selected text in the document. |
11771177| `editorId` | `string` | No | The editor ID associated with this comment. |
11781178
1179+ ### CKEditor
1180+
1181+ <a id="ckeditor-addcommentrequest" />
1182+
1183+ #### AddCommentRequest
1184+
1185+ ---
1186+
1187+ Request interface for the CKEditor `addComment()` function.
1188+
1189+ | Property | Type | Required | Description |
1190+ | ---------- | -------------------------- | -------- | ---------------------------------------------------- |
1191+ | `editor` | `Editor` | Yes | CKEditor 5 editor instance. |
1192+ | `editorId` | `string` | No | Optional editor ID used to scope operations. |
1193+ | `context` | [`CommentAnnotationContext`](#ckeditor-commentannotationcontext) | No | Optional custom context to attach to the annotation. |
1194+
1195+ <a id="ckeditor-rendercommentsrequest" />
1196+
1197+ #### RenderCommentsRequest
1198+
1199+ ---
1200+
1201+ Request interface for the CKEditor `renderComments()` function.
1202+
1203+ | Property | Type | Required | Description |
1204+ | -------------------- | --------------------- | -------- | -------------------------------------------- |
1205+ | `editor` | `Editor` | Yes | CKEditor 5 editor instance. |
1206+ | `editorId` | `string` | No | Optional editor ID used to scope operations. |
1207+ | `commentAnnotations` | `CommentAnnotation[]` | No | Annotations to render/highlight. |
1208+
1209+ For the CommentAnnotation model referenced above, see [CommentAnnotation](#commentannotation).
1210+
1211+ <a id="ckeditor-veltcommentspluginconfig" />
1212+
1213+ #### VeltCommentsPluginConfig
1214+
1215+ ---
1216+
1217+ Configuration options for `config.veltComments` in the CKEditor editor config.
1218+
1219+ | Property | Type | Required | Description |
1220+ | ------------------ | --------- | -------- | ------------------------------------------------------------------------ |
1221+ | `editorId` | `string` | No | Unique identifier for this editor instance. |
1222+ | `persistVeltMarks` | `boolean` | No | Reserved for API parity; highlights are always rendered as an overlay. |
1223+
1224+ <a id="ckeditor-commentannotationcontext" />
1225+
1226+ #### CommentAnnotationContext
1227+
1228+ ---
1229+
1230+ Context object merged into the Velt comment annotation by `addComment()`.
1231+
1232+ | Property | Type | Required | Description |
1233+ | ------------------ | ------------------------------------------------ | -------- | ---------------------------------------------------------- |
1234+ | `textEditorConfig` | [`TextEditorConfig`](#ckeditor-texteditorconfig) | No | Text editor configuration auto-generated by the library. |
1235+ | `[key: string]` | `unknown` | No | Additional custom properties to attach to the annotation. |
1236+
1237+ <a id="ckeditor-texteditorconfig" />
1238+
1239+ #### TextEditorConfig
1240+
1241+ ---
1242+
1243+ Logical text anchor stored in `annotation.context.textEditorConfig`.
1244+
1245+ | Property | Type | Required | Description |
1246+ | ------------ | -------- | -------- | ------------------------------------------------- |
1247+ | `text` | `string` | Yes | The selected text content. |
1248+ | `occurrence` | `number` | Yes | The occurrence index of the text in the document. |
1249+ | `editorId` | `string` | No | The editor ID associated with this comment. |
1250+
11791251### Monaco
11801252
11811253#### AddCommentRequest
0 commit comments