Skip to content

feat: add onHighlightComplete callback to Code and Diff renderables #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
remorses wants to merge 1 commit into
base: format-table
Choose a base branch
from
Draft

feat: add onHighlightComplete callback to Code and Diff renderables #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/core/src/renderables/Code.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export interface CodeOptions extends TextBufferOptions {
conceal?: boolean
drawUnstyledText?: boolean
streaming?: boolean
onHighlightComplete?: () => void
}

export class CodeRenderable extends TextBufferRenderable {
Expand All @@ -31,6 +32,7 @@ export class CodeRenderable extends TextBufferRenderable {
private _streaming: boolean
private _hadInitialContent: boolean = false
private _lastHighlights: SimpleHighlight[] = []
private _onHighlightComplete?: () => void

protected _contentDefaultOptions = {
content: "",
Expand All @@ -49,6 +51,7 @@ export class CodeRenderable extends TextBufferRenderable {
this._conceal = options.conceal ?? this._contentDefaultOptions.conceal
this._drawUnstyledText = options.drawUnstyledText ?? this._contentDefaultOptions.drawUnstyledText
this._streaming = options.streaming ?? this._contentDefaultOptions.streaming
this._onHighlightComplete = options.onHighlightComplete

// Set initial content immediately so lineCount is correct for measure functions
// This prevents width glitches in parent components like LineNumberRenderable
Expand Down Expand Up @@ -148,6 +151,14 @@ export class CodeRenderable extends TextBufferRenderable {
}
}

get onHighlightComplete(): (() => void) | undefined {
return this._onHighlightComplete
}

set onHighlightComplete(value: (() => void) | undefined) {
this._onHighlightComplete = value
}

private ensureVisibleTextBeforeHighlight(): void {
const content = this._content

Expand Down Expand Up @@ -247,6 +258,7 @@ export class CodeRenderable extends TextBufferRenderable {
this._isHighlighting = false
this._highlightsDirty = false
this.requestRender()
this._onHighlightComplete?.()
} catch (error) {
// Check if this result is stale
if (snapshotId !== this._highlightSnapshotId) {
Expand All @@ -261,6 +273,7 @@ export class CodeRenderable extends TextBufferRenderable {
this._isHighlighting = false
this._highlightsDirty = false
this.requestRender()
this._onHighlightComplete?.()
}
}

Expand Down
18 changes: 18 additions & 0 deletions packages/core/src/renderables/Diff.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export interface DiffRenderableOptions extends RenderableOptions<DiffRenderable>
removedSignColor?: string | RGBA
addedLineNumberBg?: string | RGBA
removedLineNumberBg?: string | RGBA
onHighlightComplete?: () => void
}

export class DiffRenderable extends Renderable {
Expand Down Expand Up @@ -106,6 +107,9 @@ export class DiffRenderable extends Renderable {
private errorTextRenderable: TextRenderable | null = null
private errorCodeRenderable: CodeRenderable | null = null

private _onHighlightComplete?: () => void
private _pendingHighlights = 0

constructor(ctx: RenderContext, options: DiffRenderableOptions) {
super(ctx, {
...options,
Expand Down Expand Up @@ -141,6 +145,7 @@ export class DiffRenderable extends Renderable {
this._removedSignColor = parseColor(options.removedSignColor ?? "#ef4444")
this._addedLineNumberBg = parseColor(options.addedLineNumberBg ?? "transparent")
this._removedLineNumberBg = parseColor(options.removedLineNumberBg ?? "transparent")
this._onHighlightComplete = options.onHighlightComplete

// Only parse and build if diff is provided
if (this._diff) {
Expand Down Expand Up @@ -240,6 +245,13 @@ export class DiffRenderable extends Renderable {
super.destroyRecursively()
}

private handleHighlightComplete(): void {
this._pendingHighlights--
if (this._pendingHighlights === 0 && this._onHighlightComplete) {
this._onHighlightComplete()
}
}

/**
* Create or update a CodeRenderable with the given content and options.
* Reuses existing instances to avoid expensive recreation.
Expand Down Expand Up @@ -315,6 +327,10 @@ export class DiffRenderable extends Renderable {
): CodeRenderable {
const existingRenderable = side === "left" ? this.leftCodeRenderable : this.rightCodeRenderable

if (this._filetype) {
this._pendingHighlights++
}

if (!existingRenderable) {
// Create new CodeRenderable
const codeOptions: CodeOptions = {
Expand All @@ -326,6 +342,7 @@ export class DiffRenderable extends Renderable {
syntaxStyle: this._syntaxStyle ?? SyntaxStyle.create(),
width: "100%",
height: "100%",
onHighlightComplete: () => this.handleHighlightComplete(),
...(this._fg !== undefined && { fg: this._fg }),
...(drawUnstyledText !== undefined && { drawUnstyledText }),
...(this._selectionBg !== undefined && { selectionBg: this._selectionBg }),
Expand All @@ -346,6 +363,7 @@ export class DiffRenderable extends Renderable {
existingRenderable.content = content
existingRenderable.wrapMode = wrapMode ?? "none"
existingRenderable.conceal = this._conceal
existingRenderable.onHighlightComplete = () => this.handleHighlightComplete()
if (drawUnstyledText !== undefined) {
existingRenderable.drawUnstyledText = drawUnstyledText
}
Expand Down
Loading