add registerBufferElementProvider (#4402)

This commit is contained in:
Megan Rogge
2023-02-07 09:56:23 -08:00
committed by GitHub
parent 6daadc4c55
commit 72a157df5e
7 changed files with 77 additions and 19 deletions
+15
View File
@@ -1108,6 +1108,14 @@ declare module 'xterm' {
* @param addon The addon to load.
*/
loadAddon(addon: ITerminalAddon): void;
/*
* Registers a buffer element provider which will provide a custom element to
* use in the terminal's accessible buffer. Using this an xterm.js embedder
* has full control over how the buffer is represented in the DOM.
* @param bufferElementProvider The buffer element provider.
*/
registerBufferElementProvider(bufferProvider: IBufferElementProvider): IDisposable;
}
/**
@@ -1360,6 +1368,13 @@ declare module 'xterm' {
getNullCell(): IBufferCell;
}
export interface IBufferElementProvider {
/**
* Provides a document fragment containing the buffer elements.
*/
provideBufferElements(): DocumentFragment;
}
/**
* Represents the terminal's set of buffers.
*/