xterm使用

2023-10-11 22:50
文章标签 使用 xterm

本文主要是介绍xterm使用，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

xterm使用

  • 前言
  • 1. xterm介绍
  • 2. xterm使用
    • 2.1 xterm简单示例
    • 2.2 xterm监听输入并在终端中实时显示
      • 方式1:onKey监听
      • 方式2:onData监听
      • onData和onKey什么区别
    • 2.3 xterm与vue整合
    • 2.3 xterm + vue + websocket
  • 附录
    • 配置说明

前言

vue与xterm整合记录

1. xterm介绍

xterm 是一个基于 Web 技术的终端模拟器，它可以在浏览器中创建交互式终端界面。xterm 提供了一种强大的方式来将终端功能集成到 Web 应用程序中，使用户能够在浏览器中与远程服务器或本地命令行进行交互

2. xterm使用

2.1 xterm简单示例

<!DOCTYPE html>
<html>
<head><title>xterm-01</title><!-- 引入 xterm 的 CSS 文件 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css">
</head>
<body><h1>xterm 简单示例</h1><!-- 创建一个容器用于放置 xterm 组件 --><div id="terminal"></div><!-- 引入 xterm 的 JavaScript 文件 --><script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script><script>// 创建一个 xterm 组件并将其连接到容器const xterm = new Terminal();xterm.open(document.getElementById('terminal'));// 向终端写入消息xterm.writeln('欢迎使用 xterm!');</script>
</body>
</html>

效果：
在这里插入图片描述
默认宽度不会自适应,可以通过xterm-addon-fit.js实现宽度适配

https://unpkg.com/xterm-addon-fit@0.6.0/lib/xterm-addon-fit.js

<!DOCTYPE html>
<html>
<head><title>xterm-01</title><!-- 引入 xterm 的 CSS 文件 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css">
</head>
<body>
<h1>xterm 宽度自适应示例</h1>
<!-- 创建一个容器用于放置 xterm 组件 -->
<div id="terminal"></div><!-- 引入 xterm 的 JavaScript 文件 -->
<script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script>
<!--xterm 横向自适应-->
<script  src="https://unpkg.com/xterm-addon-fit@0.6.0/lib/xterm-addon-fit.js"></script>
<script>// 创建一个 xterm 组件并将其连接到容器const xterm = new Terminal();const fitAddon = new FitAddon.FitAddon();xterm.loadAddon(fitAddon)xterm.open(document.getElementById('terminal'));//黑窗口适应实际div宽高fitAddon.fit()// 向终端写入消息xterm.writeln('欢迎使用 xterm!');
</script>
</body>
</html>

效果:
在这里插入图片描述

2.2 xterm监听输入并在终端中实时显示

方式1:onKey监听

<!DOCTYPE html>
<html>
<head><title>xterm-02</title><!-- 引入 xterm 的 CSS 文件 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css">
</head>
<body>
<h1>xterm 监听输入并在终端中实时显示</h1>
<!-- 创建一个容器用于放置 xterm 组件 -->
<div id="terminal"></div><!-- 引入 xterm 的 JavaScript 文件 -->
<script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script>
<script>// 创建一个 xterm 组件并将其连接到容器const xterm = new Terminal();xterm.open(document.getElementById('terminal'));// 向终端写入消息xterm.writeln('欢迎使用 xterm!');// 监听输入并在终端中实时显示xterm.onKey((e) => {const printable = !e.domEvent.altKey && !e.domEvent.ctrlKey && !e.domEvent.metaKey;if (e.domEvent.keyCode === 13) {// 处理回车键，添加换行xterm.writeln('');} else if (e.domEvent.keyCode === 8) {// 处理退格键，删除最后一个字符xterm.write('\b \b');} else if (printable) {// 处理可打印字符xterm.write(e.key);}});
</script>
</body>
</html>

方式2:onData监听

<!DOCTYPE html>
<html>
<head><title>xterm-02</title><!-- 引入 xterm 的 CSS 文件 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css">
</head>
<body>
<h1>xterm 监听输入并在终端中实时显示</h1>
<!-- 创建一个容器用于放置 xterm 组件 -->
<div id="terminal"></div><!-- 引入 xterm 的 JavaScript 文件 -->
<script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script>
<script>// 创建一个 xterm 组件并将其连接到容器const xterm = new Terminal();xterm.open(document.getElementById('terminal'));// 向终端写入消息xterm.writeln('欢迎使用 xterm!');// 监听输入并在终端中实时显示xterm.onData((data) => {const printable = data.match(/[\x20-\x7E]/); // 匹配可打印字符的正则表达式if (data === '\r' || data === '\x0D') {// 处理回车键，添加换行xterm.writeln('');} else if (data === '\x08' || data === '\x7F') {// 处理退格键，删除最后一个字符xterm.write('\b \b');} else if (printable) {// 处理可打印字符xterm.write(data);}});
</script>
</body>
</html>

效果:
在这里插入图片描述

onData和onKey什么区别

xterm.onData： 用于捕获用户在终端中输入的所有数据，包括不可见字符（例如回车、换行等）。它不区分特殊键和可打印字符，而是将用户输入的所有字符都视为数据

xterm.onData((data) => {// 处理用户输入的数据，包括特殊字符console.log(data);
});

xterm.onKey： 用于捕获用户在终端中按下的键盘事件，但它通常用于处理可打印字符（即可见字符，例如字母、数字、符号等）。它区分特殊键和可打印字符，以便你可以根据需要对它们进行处理。

xterm.onKey((e) => {if (e.domEvent.key === 'Enter') {// 处理回车键事件} else if (e.domEvent.key === 'Backspace') {// 处理退格键事件} else {// 处理可打印字符事件console.log(e.key);}
});

场景推荐

  • xterm.onData 获取所有数据(onKey就没法复制后粘贴数据)适合和后端websocket持续交互传输
  • xterm.onKey 可以做成快捷键,和xterm.onData 结合使用

在这里插入图片描述

<!DOCTYPE html>
<html>
<head><title>xterm-02</title><!-- 引入 xterm 的 CSS 文件 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css">
</head>
<body>
<h1>xterm 监听输入并在终端中实时显示</h1>
<!-- 创建一个容器用于放置 xterm 组件 -->
<div id="terminal"></div>
<div><h2>快捷键命令列表</h2><ul id="shortcut-list"></ul><form id="shortcut-form"><label for="shortcut">快捷键：</label><input type="text" id="shortcut" name="shortcut"><label for="command">命令：</label><input type="text" id="command" name="command"><button type="button" onclick="addShortcut()">添加</button></form>
</div><!-- 引入 xterm 的 JavaScript 文件 -->
<script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script>
<script>// 创建一个 xterm 组件并将其连接到容器const xterm = new Terminal();xterm.open(document.getElementById('terminal'));// 向终端写入消息xterm.writeln('欢迎使用 xterm!');// 监听输入并在终端中实时显示xterm.onData((data) => {const printable = data.match(/[\x20-\x7E]/); // 匹配可打印字符的正则表达式if (data === '\r' || data === '\x0D') {// 处理回车键，添加换行xterm.writeln('');} else if (data === '\x08' || data === '\x7F') {// 处理退格键，删除最后一个字符xterm.write('\b \b');} else if (printable) {// 处理可打印字符xterm.write(data);}});// 快捷键与命令的映射const shortcutMap = {};// 在快捷键命令列表中展示const shortcutList = document.getElementById('shortcut-list');function updateShortcutList() {shortcutList.innerHTML = '';for (const shortcut in shortcutMap) {const command = shortcutMap[shortcut];const listItem = document.createElement('li');listItem.textContent = `${shortcut}: ${command}`;shortcutList.appendChild(listItem);}}// 添加快捷键与命令的关系function addShortcut() {const shortcutInput = document.getElementById('shortcut');const commandInput = document.getElementById('command');const shortcut = shortcutInput.value;const command = commandInput.value;if (shortcut && command) {shortcutMap[shortcut] = command;shortcutInput.value = '';commandInput.value = '';updateShortcutList();}}// 在 xterm 组件上监听键盘事件，在终端中输入相应的命令xterm.onKey((e) => {const shortcut = getShortcutKey(e.domEvent);if (shortcut && shortcutMap[shortcut]) {const command = shortcutMap[shortcut];xterm.write(command);}});// 获取组合键的字符串表示（Ctrl+A）function getShortcutKey(event) {const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;const ctrlKey = isMac ? event.metaKey : event.ctrlKey;if (ctrlKey) {return `Ctrl+${String.fromCharCode(event.keyCode)}`;}return null;}
</script>
</body>
</html>

2.3 xterm与vue整合

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>iView Tabs with xterm.js</title><!-- 引入 Vue.js --><script src="https://cdn.jsdelivr.net/npm/vue@2.6.14/dist/vue.js"></script><!-- 引入 iView 样式和脚本 --><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/iview@2.9.1/dist/styles/iview.css"><script src="https://cdn.jsdelivr.net/npm/iview@2.9.1/dist/iview.min.js"></script><!-- 引入样式 --><link rel="stylesheet" href="https://unpkg.com/xterm@4.18.0/css/xterm.css"><script src="https://unpkg.com/xterm@4.18.0/lib/xterm.js"></script>
</head>
<body>
<div id="app"><tabs v-model="activeTabName" @on-click="handleTabClick"><tab-pane v-for="tab in tabs" :name="tab.name" :label="tab.label"><!-- 在这里渲染 xterm 组件 --><div :ref="'xterm_' + tab.name"></div></tab-pane></tabs>
</div><script>new Vue({el: '#app',data() {return {activeTabName: '', // 当前激活的标签页名称tabs: [ // 标签页数据，可以根据需要进行动态添加{ name: 'tab1', label: 'Tab 1' },{ name: 'tab2', label: 'Tab 2' },// 添加更多标签页...],xtermInstances: {},};},methods: {handleTabClick(tabName) {// 处理标签页点击事件this.activeTabName = tabName;if (!this.xtermInstances[tabName]) {this.initializeXterm(this.activeTabName);}},initializeXterm(tabName) {// 初始化 xterm 终端const xterm = new Terminal({convertEol: true,//控制终端是否自动将 \n 转换为 \r\n。cursorBlink: true,//指定光标是否闪烁screenKeys: true});xterm.open(this.$refs['xterm_' + tabName][0]);// 写入数据xterm.write(tabName + " xterm created \r\n")// 监听键盘数据xterm.onData((data) => {// console.log(tabName + ':'+ data)// if (data =='\r') {//     data = '\r\n'// }xterm.write(data)})this.xtermInstances[tabName] = xterm;}},mounted() {// 初始化第一个标签页的 xterm 终端this.activeTabName = this.tabs[0].name;this.initializeXterm(this.activeTabName);}});
</script>
</body>
</html>

效果
在这里插入图片描述

2.3 xterm + vue + websocket

附录

配置说明

配置选项作用默认值
cols 和 rows指定终端的列数和行数，控制终端的大小。cols: 80，rows: 24
cursorBlink指定光标是否闪烁。cursorBlink: false
cursorStyle指定光标的样式，可以是 "block"、"underline" 或 "bar"。cursorStyle: "block"
bellStyle指定响铃（Bell）的样式，可以是 "none"、"sound" 或 "visual"。bellStyle: "none"
theme定义终端的主题，可以通过设置不同的颜色和样式来自定义终端的外观。theme: { foreground: "#ffffff", background: "#000000" }
fontFamily指定终端的字体族（font family）。fontFamily: "Menlo, Monaco, Consolas, "Courier New", monospace"
fontSize指定终端的字体大小。fontSize: 12
fontWeight指定终端字体的粗细。fontWeight: "normal"
lineHeight指定行高。lineHeight: 1.0
fontSmoothing字体平滑设置，可以是 "antialiased"、"subpixel-antialiased" 或 "none"。fontSmoothing: "antialiased"
convertEol控制终端是否自动将 \n 转换为 \r\n。convertEol: true
scrollback指定滚动缓冲区的行数，用于在终端中查看历史输出。scrollback: 1000
screenReaderMode启用屏幕阅读器模式，以支持可访问性。screenReaderMode: false
tabStopWidth指定制表符的宽度，以控制文本缩进。tabStopWidth: 8
rendererType指定绘图渲染器的类型，可以是 "canvas" 或 "dom"。rendererType: "canvas"
rightClickSelectsWord控制右键单击是否选择整个单词。rightClickSelectsWord: false

这篇关于xterm使用的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/191389。

相关文章

GO语言中函数命名返回值的使用

GO语言中函数命名返回值的使用

《GO语言中函数命名返回值的使用》在Go语言中,函数可以为其返回值指定名称,这被称为命名返回值或命名返回参数,这种特性可以使代码更清晰,特别是在返回多个值时,感兴趣的可以了解一下... 目录基本语法函数命名返回特点代码示例命名特点基本语法func functionName(parameters) (nam
阅读更多...
使用shardingsphere实现mysql数据库分片方式

使用shardingsphere实现mysql数据库分片方式

《使用shardingsphere实现mysql数据库分片方式》本文介绍如何使用ShardingSphere-JDBC在SpringBoot中实现MySQL水平分库,涵盖分片策略、路由算法及零侵入配置... 目录一、ShardingSphere 简介1.1 对比1.2 核心概念1.3 Sharding-Sp
阅读更多...
Java 正则表达式的使用实战案例

Java 正则表达式的使用实战案例

《Java正则表达式的使用实战案例》本文详细介绍了Java正则表达式的使用方法,涵盖语法细节、核心类方法、高级特性及实战案例,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录一、正则表达式语法详解1. 基础字符匹配2. 字符类（[]定义）3. 量词（控制匹配次数）4. 边
阅读更多...
Python Counter 函数使用案例

Python Counter 函数使用案例

《PythonCounter函数使用案例》Counter是collections模块中的一个类,专门用于对可迭代对象中的元素进行计数,接下来通过本文给大家介绍PythonCounter函数使用案例... 目录一、Counter函数概述二、基本使用案例（一）列表元素计数（二）字符串字符计数（三）元组计数三、C
阅读更多...
使用Spring Cache本地缓存示例代码

使用Spring Cache本地缓存示例代码

《使用SpringCache本地缓存示例代码》缓存是提高应用程序性能的重要手段,通过将频繁访问的数据存储在内存中,可以减少数据库访问次数,从而加速数据读取,：本文主要介绍使用SpringCac... 目录一、Spring Cache简介核心特点：二、基础配置1. 添加依赖2. 启用缓存3. 缓存配置方案方案
阅读更多...
使用Python的requests库来发送HTTP请求的操作指南

使用Python的requests库来发送HTTP请求的操作指南

《使用Python的requests库来发送HTTP请求的操作指南》使用Python的requests库发送HTTP请求是非常简单和直观的,requests库提供了丰富的API,可以发送各种类型的HT... 目录前言1. 安装 requests 库2. 发送 GET 请求3. 发送 POST 请求4. 发送
阅读更多...
Nginx中配置使用非默认80端口进行服务的完整指南

Nginx中配置使用非默认80端口进行服务的完整指南

《Nginx中配置使用非默认80端口进行服务的完整指南》在实际生产环境中,我们经常需要将Nginx配置在其他端口上运行,本文将详细介绍如何在Nginx中配置使用非默认端口进行服务,希望对大家有所帮助... 目录一、为什么需要使用非默认端口二、配置Nginx使用非默认端口的基本方法2.1 修改listen指令
阅读更多...
Python WebSockets 库从基础到实战使用举例

Python WebSockets 库从基础到实战使用举例

《PythonWebSockets库从基础到实战使用举例》WebSocket是一种全双工、持久化的网络通信协议,适用于需要低延迟的应用,如实时聊天、股票行情推送、在线协作、多人游戏等,本文给大家介... 目录1. 引言2. 为什么使用 WebSocket？3. 安装 WebSockets 库4. 使用 We
阅读更多...
python中的显式声明类型参数使用方式

python中的显式声明类型参数使用方式

《python中的显式声明类型参数使用方式》文章探讨了Python3.10+版本中类型注解的使用,指出FastAPI官方示例强调显式声明参数类型,通过|操作符替代Union/Optional,可提升代... 目录背景python函数显式声明的类型汇总基本类型集合类型Optional and Union(py
阅读更多...
Java使用正则提取字符串中的内容的详细步骤

Java使用正则提取字符串中的内容的详细步骤

《Java使用正则提取字符串中的内容的详细步骤》：本文主要介绍Java中使用正则表达式提取字符串内容的方法,通过Pattern和Matcher类实现,涵盖编译正则、查找匹配、分组捕获、数字与邮箱提... 目录1. 基础流程2. 关键方法说明3. 常见场景示例场景1：提取所有数字场景2：提取邮箱地址4. 高级
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2