Skip to content

Render comments in the editor UI #26

@jedrazb

Description

@jedrazb

Summary

Comments parsed from DOCX files (comments.xml) are currently stored in the document model but not rendered anywhere in the editor UI. Users cannot see, add, or interact with comments.

Current State

  • Parsing: Works. commentParser.ts extracts comments including author, date, initials, and content paragraphs. PR Fix comment timestamps using commentsExtensible.xml #21 adds UTC timestamp support via commentsExtensible.xml.
  • Data model: Comment type exists in src/types/content.ts with id, author, initials, date, and content fields.
  • Rendering: Not implemented. Comments are parsed but never displayed.

What needs to happen

  1. Comment range markers in ProseMirror — Map w:commentRangeStart / w:commentRangeEnd from the document XML to ProseMirror decorations or marks so the editor knows which text spans are commented
  2. Comment highlight rendering — Highlight commented text ranges in the visible pages (layout-painter) with a subtle background color (Word uses light yellow)
  3. Comment sidebar/panel — Display comments in a sidebar or tooltip showing author, date, and comment text, linked to highlighted ranges
  4. Comment indicators — Show visual indicators (e.g., colored marks in the margin) for commented sections

Out of scope (for now)

  • Adding new comments
  • Replying to comments
  • Resolving/deleting comments
  • Tracked changes

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions