ReviseEditorHandle

onReady hands you a ReviseEditorHandle. Keep it in a ref; every controller on it is stable for the life of the component.

const editor = useRef<ReviseEditorHandle | null>(null);

<ReviseEditor onReady={(handle) => (editor.current = handle)} />;

Routing

Every document-local controller resolves against the active document, and every one can be bound to a specific document instead:

editor.review.next();
editor.review.forDocument("exhibit-a").next();
editor.document("exhibit-a").review.next();  // equivalent

Scoped controllers: tools, toolbar, review, view, zoom, selection, agent, comments.

documents

Promise<ReviseDocumentHandle>

Opens and parses a document. { activate: false } loads it in the background.

boolean

ReviseDocumentHandle | null

ReviseDocumentHandle

As get, but throws instead of returning null.

string | null

ReviseOpenDocument[]

ReviseDocumentCollectionState

tools

ReviseEditorToolDefinition[]

Native document-local tool schemas, excluding the delegation tool.

Promise<ReviseEditorToolExecutionResult>

Options: { documentId?, directMode? }.

Promise<Blob>

number

Live selection formatting, block type, undo/redo availability, and review counts.

void

Commands return false when they cannot apply. Grouped by area:

Area	Methods
History and clipboard	`undo`, `redo`, `copy`, `copyAs`, `cut`, `paste`, `pasteTextOnly`, `pasteFormattingOnly`
Inline	`toggleInline`, `toggleBold`, `toggleItalic`, `toggleUnderline`, `toggleStrikethrough`, `toggleDoubleStrikethrough`, `toggleSmallCaps`, `toggleAllCaps`, `toggleCode`, `toggleLatex`, `toggleSuperscript`, `toggleSubscript`, `clearFormatting`
Type	`setFontFamily`, `setFontSize`, `setLetterSpacing`, `setTextColor`, `setHighlightColor`
Paragraph	`setHeading`, `setAlignment`, `setLineSpacing`, `toggleList`, `createLink`, `increaseIndent`, `decreaseIndent`
Insert	`insertTable`, `insertImage`, `insertContainer`, `insertCodeBlock`, `insertMathBlock`, `insertDiagram`, `insertFootnote`, `insertPageNumber`, `insertPageBreak`, `insertSectionBreak`
Review	`openReview`, `closeReview`, `reviewPrevious`, `reviewNext`, `acceptCurrent`, `rejectCurrent`, `acceptAll`, `rejectAll`, `setShowRemovals`, `setSuggestionViewMode`

view

Title and the chrome the SDK no longer renders buttons for.

{ ready, title, documentMode, readOnly, commentsOpen, commentCount, reviewOpen, reviewTargetCount }

void

review

Open state, target counts, suggestion IDs, active comment, display mode, and every comment thread.

Area	Methods
Navigation	`open`, `close`, `previous`, `next`, `nextAgentSuggestion`, `navigateToSuggestion`, `navigateWithinSuggestions`
Decisions	`acceptCurrent`, `rejectCurrent`, `acceptAll`, `rejectAll`, `acceptSuggestions`, `rejectSuggestions`
Preview	`previewCurrent`, `previewAll`, `previewSuggestions`
Display	`setShowRemovals`, `setSuggestionViewMode`, `getOpenSuggestionIds`
Comments	`openComments`, `closeComments`, `selectComment`, `addCommentAtSelection`, `addCommentToRanges`, `addCommentToBlock`, `addCommentForSuggestion`, `replyToComment`, `setCommentResolved`, `deleteComment`, `getRelatedSuggestionIds`, `acceptCommentSuggestions`, `rejectCommentSuggestions`

selection

ReviseSelectionSnapshot

ReviseSelectionCapture | null

Survives focus moving into your UI. null when there is nothing addressable.

ReviseSelectionRestoreResult

Typed failure when the document changed underneath it.

void

zoom

{ zoom, scale }

void

agent

Promise<ReviseAgentRunResult>

boolean

Guidance for a run already in flight.

void

comments

Agent runs scoped to a single comment thread.

Promise<CommentAgentRunResult>

boolean

void

CommentAgentRunState | undefined

Publishes a map of every in-flight run.

Convenience

Shorthands that route to the active document unless given an ID:

editor.getDocument(documentId?);
editor.getDocumentMode(documentId?);
editor.setDocumentMode(mode, documentId?);
editor.getToolDefinitions(documentId?);
editor.focus(documentId?);
editor.openReview(documentId?);
editor.closeReview(documentId?);
editor.openComments(documentId?);
editor.closeComments(documentId?);

Getting started

Guides

API reference

Routing

documents

tools

view

review

selection

zoom

agent

comments

Convenience

​Routing

​documents

​tools

​toolbar

​view

​review

​selection

​zoom

​agent

​comments

​Convenience

Routing

documents

tools

toolbar

view

review

selection

zoom

agent

comments

Convenience