Domain

ReviewEditor

Markdown editor extended with inline review threads, anchored comments, and collaborative annotation state.

import { ReviewEditor } from '@lostgradient/editor/review-editor';
markdownreviewdomain-suite
01

Overview

Markdown editor extended with inline review threads, anchored comments, and collaborative annotation state.

Usage

svelte
<script lang="ts">
  import { ReviewEditor } from '@lostgradient/editor/review-editor';
</script>

Guidance

Use When

  • Building a document review experience that needs both a Markdown editor and anchored comment threads in one bundled surface.
  • Threading reviewer commentary against specific selections inside a long-form document.

Avoid When

  • Plain authoring with no review threads — markdown-editor is the lighter primitive.
  • Reviewing diffs between two documents rather than annotating one — use diff-viewer instead.
Live preview
02

When to use

Use when
  • Building a document review experience that needs both a Markdown editor and anchored comment threads in one bundled surface.
  • Threading reviewer commentary against specific selections inside a long-form document.
Avoid when
  • Plain authoring with no review threads — markdown-editor is the lighter primitive.
  • Reviewing diffs between two documents rather than annotating one — use diff-viewer instead.
03

Examples

Basic review editor

Editable markdown with source, rendered, and diff views.

Review editor with comments

Anchored text comments and document-level feedback.

04

Props

Props for review-editor
Name Type Default Required Bindable Description
original text '' bind Original/baseline content for diff comparison.
value text '' bind Current markdown content (two-way bindable).
threads Thread[] [] bind Comment threads (two-way bindable).