You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/sdk/models/data-models.mdx
+62Lines changed: 62 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1075,6 +1075,68 @@ Context extracted from the current ProseMirror editor selection.
1075
1075
| `occurrence` | `number` | Yes | 1-based index of `text` among all matches in the document. |
1076
1076
| `locationId` | `string` | No | Optional Velt location id derived from a `data-velt-location-id` ancestor. |
1077
1077
1078
+
### TinyMCE
1079
+
1080
+
#### AddCommentRequest
1081
+
1082
+
---
1083
+
1084
+
Request interface for the TinyMCE `addComment()` function. The library automatically writes `context.textEditorConfig` with the selected text, its 1-based occurrence index in the document, and the editor ID when one is provided.
| `editorId` | `string` | No | Optional editor ID used to scope operations. |
1090
+
| `context` | [`CommentAnnotationContext`](#commentannotationcontext-2) | No | Optional custom context to attach to the annotation. |
1091
+
1092
+
#### RenderCommentsRequest
1093
+
1094
+
---
1095
+
1096
+
Request interface for the TinyMCE `renderComments()` function. Comments are resolved back to TinyMCE DOM ranges and rendered as view-only overlay elements.
| `editorId` | `string` | No | Optional editor ID used to scope operations. |
1102
+
| `commentAnnotations` | `CommentAnnotation[]` | No | Annotations to render/highlight. |
1103
+
1104
+
For the CommentAnnotation model referenced above, see [CommentAnnotation](#commentannotation).
1105
+
1106
+
#### TinymceVeltCommentsConfig
1107
+
1108
+
---
1109
+
1110
+
Configuration options for the TinyMCE Velt comments plugin. In TinyMCE init options, `editorId` maps to `velt_comments_editor_id` and `persistVeltMarks` maps to `velt_comments_persist_marks`.
0 commit comments