PyModel/pythinker-code / .agents/skills/opentui
opentui
VerifiedBuild terminal UIs with OpenTUI. Covers core, components, audio, keymaps, React, Solid, plugins, testing, standalone executables, QR encoding, SSH, and Three.js WebGPU.
docs/components/diff.mdx
View on GitHub---
title: Diff
description: Unified or split diff viewer
order: 15
---
# Diff
Render unified or split diffs with syntax highlighting and optional line numbers.
## Basic usage
### Renderable API
```typescript
import { DiffRenderable, SyntaxStyle, RGBA, createCliRenderer } from "@opentui/core"
const renderer = await createCliRenderer()
const syntaxStyle = SyntaxStyle.fromStyles({
default: { fg: RGBA.fromHex("#E6EDF3") },
string: { fg: RGBA.fromHex("#A5D6FF") },
keyword: { fg: RGBA.fromHex("#FF7B72"), bold: true },
})
const diff = new DiffRenderable(renderer, {
id: "diff",
width: "100%",
height: 16,
diff: `diff --git a/app.ts b/app.ts\nindex 1111111..2222222 100644\n--- a/app.ts\n+++ b/app.ts\n@@ -1,3 +1,3 @@\n-const a = 1\n+const a = 2\n`,
view: "split",
filetype: "typescript",
syntaxStyle,
showLineNumbers: true,
})
renderer.root.add(diff)
```
## Construct API
> Not available yet. Use `DiffRenderable` for now.
## Split view scroll sync
When `view: "split"` is active, you can link the vertical scroll of both panes. Scrolling one pane then moves the other:
```typescript
const diff = new DiffRenderable(renderer, {
id: "diff",
view: "split",
syncScroll: true,
diff: patch,
syntaxStyle,
})
// Toggle at runtime
diff.syncScroll = false
```
Scroll sync is a no-op in the unified view.
## Properties
| Property | Type | Default | Description |
| --------------------- | ------------------------------- | ----------- | ------------------------------------- |
| `diff` | `string` | `""` | Unified diff string |
| `view` | `"unified"` or `"split"` | `"unified"` | Layout style |
| `syncScroll` | `boolean` | `false` | Link vertical scroll in split view |
| `filetype` | `string` | - | Syntax highlighting language |
| `fg` | `string` or `RGBA` | - | Base foreground for inner code panes |
| `syntaxStyle` | `SyntaxStyle` | - | Syntax style for code |
| `wrapMode` | `"word"`, `"char"`, or `"none"` | - | Code wrapping mode |
| `conceal` | `boolean` | `false` | Conceal markup when highlighting |
| `selectionBg` | `string` or `RGBA` | - | Selection background in code panes |
| `selectionFg` | `string` or `RGBA` | - | Selection foreground in code panes |
| `treeSitterClient` | `TreeSitterClient` | - | Custom Tree-sitter client |
| `showLineNumbers` | `boolean` | `true` | Show line numbers |
| `lineNumberFg` | `string` or `RGBA` | `#888888` | Line number text color |
| `lineNumberBg` | `string` or `RGBA` | transparent | Line number background |
| `addedLineNumberBg` | `string` or `RGBA` | transparent | Line number background for added |
| `removedLineNumberBg` | `string` or `RGBA` | transparent | Line number background for removed |
| `addedBg` | `string` or `RGBA` | `#1a4d1a` | Background for added lines |
| `removedBg` | `string` or `RGBA` | `#4d1a1a` | Background for removed lines |
| `contextBg` | `string` or `RGBA` | transparent | Background for context lines |
| `addedContentBg` | `string` or `RGBA` | - | Optional content background (added) |
| `removedContentBg` | `string` or `RGBA` | - | Optional content background (removed) |
| `contextContentBg` | `string` or `RGBA` | - | Optional content background (context) |
| `addedSignColor` | `string` or `RGBA` | `#22c55e` | Sign color for added lines |
| `removedSignColor` | `string` or `RGBA` | `#ef4444` | Sign color for removed lines |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |