Quickstart

Install

The SDK ships as a self-contained npm tarball. React and ReactDOM stay your peer dependencies — the package never bundles its own copy.

npm install @revise/editor-sdk

pnpm add @revise/editor-sdk

yarn add @revise/editor-sdk

Requires React 18 or newer and Node 18 or newer to build. The component is browser-only: render it client-side (in Next.js, a "use client" component, usually behind next/dynamic with ssr: false).

Import the stylesheet once, anywhere in your application:

import "@revise/editor-sdk/style.css";

Render a document

ReviseEditor is a multi-document workspace. Give each document a stable ID that you own — the SDK uses it for routing, callbacks, and agent tools. The source can be a DOCX, Markdown, plain text, or HTML file; see supported formats.

DocumentPane.tsx

import { ReviseEditor, type ReviseEditorHandle } from "@revise/editor-sdk";
import "@revise/editor-sdk/style.css";
import { useRef } from "react";

export function DocumentPane({ file }: { file: File }) {
  const editor = useRef<ReviseEditorHandle | null>(null);

  return (
    <ReviseEditor
      initialDocuments={[{ id: "contract-1", title: "Contract", docx: file }]}
      onReady={(handle) => {
        editor.current = handle;
      }}
      onChange={(documentId, document) => {
        console.log(documentId, "now has", document.children.length, "blocks");
      }}
    />
  );
}

That is a complete integration. The component owns parsing, layout, pagination, input, undo, find, comments, and review; you own the file and the surrounding product.

Get the file back

const blob = await editor.current.tools.exportDocx();

exportDocx() returns a Blob you can download, upload, or diff. Comments and tracked changes survive the round trip.

Start from a blank document

import { createEmptyDocx } from "@revise/editor-sdk";

await editor.current.documents.open({
  id: crypto.randomUUID(),
  title: "Untitled",
  docx: await createEmptyDocx(),
});

Architecture

What the component owns, and what stays yours.

Multi-document sessions

Opening, activating, and closing documents.

Bring your own UI

Turn off the ribbon and drive the editor from your own toolbar.

Tools for your agent

Hand the document to the model you already run.

Getting started

Guides

API reference

Install

Render a document

Get the file back

Start from a blank document

What to read next

Architecture

Multi-document sessions

Bring your own UI

Tools for your agent

​Install

​Render a document

​Get the file back

​Start from a blank document

​What to read next

Architecture

Multi-document sessions

Bring your own UI

Tools for your agent

Install

Render a document

Get the file back

Start from a blank document

What to read next