浏览器中运行的命令行终端插件xterm.js

xterm 是一个使用 TypeScript 编写的前端终端组件，可以直接在浏览器中实现一个命令行终端应用。

主要特性：

终端应用程序正常工作：Xterm.js适用于大多数终端应用程序，如bash，vim和tmux，这包括对基于curses的应用程序和鼠标事件支持的支持
Performant：Xterm.js 非常快，它甚至还包括一个GPU加速的渲染器
丰富的 unicode 支持：支持CJK，表情符号和IME
自包含：零依赖性
可访问：可以使用screenReaderMode选项打开屏幕阅读器支持
还有更多：链接，主题，插件，记录良好的API等。

属性及方法：

实例化：

let term = new Terminal({
       rendererType: "canvas", //渲染类型
       rows: 40, //行数
       convertEol: true, //启用时，光标将设置为下一行的开头
       scrollback:10,//终端中的回滚量
       disableStdin: false, //是否应禁用输入。
       cursorStyle: 'underline', //光标样式
       cursorBlink: true, //光标闪烁
       theme: {
         foreground: 'yellow', //字体
         background: '#060101', //背景色
         cursor: 'help',//设置光标
       }
     })

Terminal
构造函数 constructor
创建一个新的Terminal对象

// 参数类型, 需要ITerminalOptions接口的定义
// 返回Terminal类型

new Terminal(options?: ITerminalOptions): Terminal

属性 cols
终端窗口的列数, 可以在创建Terminal指定cols

// 终端中每一行最多一列
let term = new Terminal({ cols: 1 })

属性 element
// 终端挂载的Dom元素
term.element

属性 markers
终端的所有标记


终端窗口的行数, 可以在创建Terminal指定rows

let term = new Terminal({ rows: 30 })

属性 textarea
返回, 接受终端输入的textarea的dom节点

静态属性 strings
Natural language strings that can be localized.

方法 addCsiHandler
Adds a handler for CSI escape sequences.

方法 addDisposableListener
向终端添加事件监听器, 并返回可用于删除事件监听器的对象, 对象中dispose属性的方法可以取消监听。支持的事件参考off方法的内容。

// 终端添加focus事件的监听, dispose函数可以取消监听
const { dispose } = term.addDisposableListener('focus', function () {
console.log('focus')
dispose()
})

方法 addMarker
添加标记, addMarker接受一个数字作为参数, 数字表示当前光标到标记y的偏移量，并返回标记。


let buffer = term.addMarker(cursorYOffset: number): IMarker

let term = new Terminal()
term.open(document.getElementById('app'))
term.write('Hello from \x1B[1;3;31mxterm.js\x1B')
term.addMarker(0)
term.addMarker(1)
// 返回两个标记
console.log(term.markers)

方法 addOscHandler
Adds a handler for OSC escape sequences.

方法 attachCustomKeyEventHandler
Attaches a custom key event handler which is run before keys are processed, giving consumers of xterm.js ultimate control as to what keys should be processed by the terminal and what keys should not.

方法 deregisterCharacterJoiner
Deregisters the character joiner if one was registered. NOTE: character joiners are only used by the canvas renderer.

方法 deregisterLinkMatcher
Deregisters a link matcher if it has been registered.

方法 blur
使终端失焦

方法 clear
清除整个终端, 只保留当前行

方法 selectAll
选择终端内的所有文本

方法 selectLines
选中指定的两个指定行之间的终端文本

term.write('Hello from \x1B[1;3;31mxterm.js\x1B')
term.selectLines(0, 0)

方法 clearSelection
清除当前选择的终端(只是清除选择的内容, 而非清除终端)

方法 destroy
销毁终端, 不推荐使用。推荐使用dispose()

方法 dispose
销毁终端

方法 focus
终端获得焦点

方法 getOption
获取的终端的配置选项, 需要指定配置的key
let term = new Terminal({
fontWeight: '800',
fontSize: 20
})

term.open(document.getElementById('app'))
term.write('Hello from \x1B[1;3;31mxterm.js\x1B')

// '800'
console.log(term.getOption('fontWeight'))
// 20
console.log(term.getOption('fontSize'))

详细的类型推导请参考下图

方法 getSelection
获取当前终端选择的内容。(鼠标光标选中的内容)

方法 hasSelection
判断当前终端是否有选中的内容。(鼠标光标选中的内容)

方法 off
删除事件监听, 支持的方法见上图

方法 on
添加事件监听, 支持注册的事件如上图

方法 open
打开终端。(xterm必须挂载dom完成)

方法 refresh
刷新指定两行之间的内容

方法 registerLinkMatcher
Registers a link matcher, allowing custom link patterns to be matched and handled.

方法 reset
重置整个终端

方法 resize
调整终端的大小, 参数为指定的col, row

方法 scrollLines
控制终端滚动条的滚动的行数(正数向下滚动, 负数向上滚动)

方法 scrollPages
滚动的页面树(正数向下滚动, 负数向上滚动)

方法 scrollToBottom
滚动到底部

方法 scrollToLine
滚动到具体的行

方法 scrollToTop
滚动到顶部

方法 setOption
设置终端的配置, 具体的配置请参考下图

方法 writeln
向终端写入文本并换行

方法 write
向终端写入文本

静态方法 applyAddon
添加插件到终端的原型上

接口
这里没有什么好翻译的了, Xterm.js是由TypeScript编写。这里定义Xterm内部以及外部参数和返回值的iterface

插件
attach插件
attach可以将终端附加到websocket流中。Terminal实例会捕获所有键盘和鼠标事件并通过socket发送给后端


import * as Terminal from 'xterm';
import * as attach from 'xterm/lib/addons/attach/attach';

// 添加attach插件
Terminal.applyAddon(attach);

var term = new Terminal();
var socket = new WebSocket('wss://docker.example.com/containers/mycontainerid/attach/ws');

term.attach(socket)

方法 attach
// socket socoket实例
// bidirectional 终端是否向套接字发送数据
// bufferred 终端是否缓冲输出获得更好的性能
attach(socket: WebSocket, bidirectional: Boolean, bufferred: Boolean)

方法 detach
// 分离当前终端和scoket
detach(socket)

fit
调整终端的大小以及行和列适配父级元素

fullscreen
fullscreen插件提供了设置全屏终端的toggleFullScreen方法, toggleFullScreen接受Boolean类型的值, 设置是否全屏展示终端

使用方式：

第一步引入bfwone 加载依赖项jquery

第二步use插件及css和主题css

第三步配置参数

完整示例代码如下：

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>BFW NEW PAGE</title>
    <script id="bfwone" type="text/javascript" src="//repo.bfw.wiki/bfwrepo/js/bfwone.js"></script>
    <script type="text/javascript">
        bready(function() {
            use(["xterm.4.0", "xterm.4.0"], function() {

                // HACK: This should be window.Terminal once upgraded to 4.0.1
                var term = new window.Terminal.Terminal();
                term.open(document.getElementById('terminal'));

                function runFakeTerminal() {
                    if (term._initialized) {
                        return;
                    }

                    term._initialized = true;

                    term.prompt = () => {
                        term.write('\r\n$ ');
                    };

                    term.writeln('Welcome to xterm.js');
                    term.writeln('This is a local terminal emulation, without a real terminal in the back-end.');
                    term.writeln('Type some keys and commands to play around.');
                    term.writeln('');
                    prompt(term);

                    term.onData(e => {
                        switch (e) {
                            case '\r': // Enter
                                case '\u0003': // Ctrl+C
                                    prompt(term);
                                    break;
                                case '\u007F': // Backspace (DEL)
                                    // Do not delete the prompt
                                    if (term._core.buffer.x > 2) {
                                        term.write('\b \b');
                                    }
                                    break;
                                default: // Print all other characters for demo
                                    term.write(e);
                                }
                        });
                    }

                    function prompt(term) {
                        term.write('\r\n$ ');
                    }
                    runFakeTerminal();

                });
            });
        </script>
        <style>
        </style>
    </head>
    <body>
        <div id="terminal">
           
        </div>
    </body>
</html>

官网地址：https://xtermjs.org/