Skip to main content

DiffEditor

Codeinput

The Monaco side-by-side diff surface — the only diff in the library that can be typed into.

import { DiffEditor } from "@elabs-ai/components-editor";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-editor

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui DiffEditor component (from @elabs-ai/components-editor) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look DiffEditor up before writing code: `npx -y @elabs-ai/components-cli docs DiffEditor` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-editor is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-editor` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-editor`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Avoid

  • Reaching for it to READ a patch — that is DiffView in @elabs-ai/components-ai, which needs no editor engine at all.
  • Reaching for it to approve or reject hunks — that is ChangeReview, which owns the trust gate.
  • Rendering it in a jsdom unit test — it is Monaco; test the surrounding wiring and leave the editor to a browser story.

Works with

Avoid next to

Examples

2 live examples

Inline

API

DiffEditor

PropTypeDescription
originalrequiredstringLeft/original document.
modifiedrequiredstringRight/modified document.
languagestringMonaco language id applied to both sides. Defaults to "typescript".
readOnlybooleanRead-only (diffs are read-only by default).
renderSideBySidebooleanSide-by-side (true) vs inline (false) diff. Defaults to side-by-side.
heightnumber | stringEditor height. Number → px. Defaults to "100%".
ariaLabelstringAccessible name for the diff. Each side is a Monaco editor with its own focusable screen-reader surface, so both get the name, suffixed " (original)" / " (modified)" — without it axe reports `aria-input-field-name` on both sides. Maps onto Monaco's `originalAriaLabel`/`modifiedAriaLabel` diff options, and is re-sent with every option update the component makes (Monaco resets both names on any update that omits them).
optionsmonaco.editor.IStandaloneDiffEditorConstructionOptionsPassthrough Monaco diff options (merged over the defaults).
onMount(editor: MonacoDiffEditor, monacoApi: MonacoNamespace) => voidCalled once the diff editor + monaco namespace are ready.

Also accepts: Omit<HTMLAttributes<HTMLDivElement>, "defaultValue">