@@ -955,6 +955,54 @@ Logical anchor stored in `annotation.context.textEditorConfig`. Designed to surv
955955| `pageNumber` | `number` | Yes | 1-based page number where the comment lives. |
956956| `occurrence` | `number` | Yes | 1-based count of this exact text on the page. Re-validated on each edit. |
957957
958+ ### DraftJS
959+
960+ #### DraftJSEditor
961+
962+ ---
963+
964+ Editor wrapper object passed to the DraftJS Velt comment helpers.
965+
966+ | Property | Type | Required | Description |
967+ | ---------------- | ---------------------------------- | -------- | ----------------------------------- |
968+ | `editorState` | `EditorState` | Yes | Current DraftJS editor state. |
969+ | `setEditorState` | `(state: EditorState) => void` | Yes | Function used to update the editor. |
970+
971+ #### DraftJSVeltEditorProps
972+
973+ ---
974+
975+ Props for the `DraftJSVeltEditor` React wrapper.
976+
977+ | Property | Type | Required | Description |
978+ | ------------- | -------------------------- | -------- | ------------------------------------------------------------------------------ |
979+ | `editorState` | `EditorState` | Yes | Current DraftJS editor state. |
980+ | `onChange` | `(state: EditorState) => void` | Yes | Callback invoked when the editor state changes. |
981+ | `editorId` | `string` | No | Optional editor ID used to scope operations for multi-editor pages. |
982+ | `...props` | `EditorProps` | No | Other standard DraftJS `Editor` props, such as `placeholder` or `spellCheck`. |
983+
984+ #### AddCommentRequest
985+
986+ ---
987+
988+ | Property | Type | Required | Description |
989+ | ---------- | ----------------------- | -------- | ---------------------------------------------------- |
990+ | `editor` | [`DraftJSEditor`](#draftjseditor) | Yes | DraftJS editor wrapper object. |
991+ | `editorId` | `string` | No | Optional editor ID used to scope operations. |
992+ | `context` | `unknown` | No | Optional custom context to attach to the annotation. |
993+
994+ #### RenderCommentsRequest
995+
996+ ---
997+
998+ | Property | Type | Required | Description |
999+ | -------------------- | --------------------- | -------- | -------------------------------------------- |
1000+ | `editor` | [`DraftJSEditor`](#draftjseditor) | Yes | DraftJS editor wrapper object. |
1001+ | `editorId` | `string` | No | Optional editor ID used to scope operations. |
1002+ | `commentAnnotations` | `CommentAnnotation[]` | No | Annotations to render/highlight. |
1003+
1004+ For the CommentAnnotation model referenced above, see [CommentAnnotation](#commentannotation).
1005+
9581006### Messages
9591007
9601008#### ENUMs
0 commit comments