publish 3.0.11

Author: tzfun

README.md

@@ -11,7 +11,7 @@ A web-side command line plugin built by `Vue`, supports multiple message formats
 ## Feature Support
 
 * Supported message formats: `text`, `table`, `json`, `code`/multiline text, `html`
-* `Highlight`, `Codemirror` code highlighting
+* `Highlight.js`, `Codemirror.js` code highlighting
 * ← → key cursor switch
 * ↑ ↓ key history command toggle
 * Full-screen display
@@ -192,20 +192,22 @@ The dragConf structure is as follows:
 
 ![dragging.gif](public/dragging.gif)
 
-In addition to mouse control, you can also [call API to simulate dragging](#dragging)
+In addition to mouse control, you can also [call API to simulate dragging](#dragging())
 
 ## Api
 
 This plugin provides some APIs that can use Vue to actively initiate event requests to the plugin.
 
+PS：**All api calls require the name of the terminal.**
+
 ```js
 import Terminal from "vue-web-terminal"
 
 //  det api
 Terminal.$api
 ```
 
-### pushMessage
+### pushMessage()
 
 ```js
 //  Each terminal will define a name, see the previous document for details
@@ -219,7 +221,7 @@ let message = {
 Terminal.$api.pushMessage(name, message)
 ```
 
-### updateContext
+### updateContext()
 
 For example, */vue-web-terminal/tzfun* in the current input line `$ /vue-web-terminal/tzfun > ` is the context, and the context text can be freely set by the developer, but you need to use `.sync` to bind a variable.
 
@@ -249,22 +251,24 @@ export default {
 </script>
 ```
 
-### fullscreen
+### fullscreen()
 
 Make the current terminal enter or exit full screen.
 
 ```js
 Terminal.$api.fullscreen('my-terminal')
 ```
 
+### isFullscreen()
+
 Determine if the current state is full screen.
 
 ```js
 //  true or false
 let fullscreen = Terminal.$api.isFullscreen('my-terminal')
 ```
 
-### dragging
+### dragging()
 
 When [Feature Drag](#Drag) is enabled, you can use the following method to simulate drag to change the window position, where the parameter `x` is the distance from the left border of the terminal to the left border of the browser's visible range, in px, `y ` is the distance from the upper border of the terminal to the upper border of the browser's visible range.
 
@@ -275,15 +279,15 @@ Terminal.$api.dragging('my-terminal', {
 })
 ```
 
-### execute
+### execute()
 
 You can use the api to execute a command to the Terminal, and the execution process will be echoed in the Terminal window. This is a way to use a script to simulate the user executing the command.
 
 ```js
 Terminal.$api.execute('my-terminal', 'help :local')
 ```
 
-### getPosition
+### getPosition()
 
 When in drag mode, this interface can get the position of the window.
 
@@ -292,6 +296,13 @@ let pos = Terminal.$api.getPosition('my-terminal')
 console.log(pos.x, pos.y)
 ```
 
+### focus()
+
+Get input focus
+```js
+Terminal.$api.focus('my-terminal')
+```
+
 ## Message
 
 This plugin defines a message object, any message must be defined in this format to display correctly.

README_ZH.md

@@ -157,17 +157,17 @@ example:
 
 ```vue
 <terminal :name="name" @execCmd="onExecCmd">
-  <template #header>
-    This is my custom header
-  </template>
+<template #header>
+  This is my custom header
+</template>
 
-  <template #json="data">
-    {{ data.message }}
-  </template>
+<template #json="data">
+  {{ data.message }}
+</template>
 
-  <template #helpBox="{showHeader, item}">
-    {{ item }}
-  </template>
+<template #helpBox="{showHeader, item}">
+  {{ item }}
+</template>
 </terminal>
 ```
 
@@ -176,8 +176,8 @@ example:
 开启拖拽功能需要将`showHeader`设置为true并配置`dragConf`，你可以通过dragConf的`width`和`height`来配置窗口大小。
 
 ```vue
-<terminal name="my-terminal" 
-          show-header 
+<terminal name="my-terminal"
+          show-header
           :drag-conf="{width: 700, height: 500}"></terminal>
 ```
 
@@ -192,20 +192,24 @@ dragConf结构如下：
 
 ![dragging.gif](public/dragging.gif)
 
-除了鼠标控制之外你还可以[调用API模拟拖拽](#拖拽)
+除了鼠标控制之外你还可以[调用API模拟拖拽](#dragging())
 
 ## Api
 
 本插件提供了一些 Api 可以使用 Vue 主动向插件发起事件请求。
 
+注意：**所有的API接口调用都需要用到Terminal的`name`**
+
 ```js
 import Terminal from "vue-web-terminal"
 
 //  获取api
 Terminal.$api
 ```
 
-### 向Terminal推送一条消息
+### pushMessage()
+
+向Terminal推送一条消息
 
 ```js
 let name = 'my-terminal'   //  每一个terminal都会定义一个name，详情见前面文档
@@ -218,7 +222,7 @@ let message = {
 Terminal.$api.pushMessage(name, message)
 ```
 
-### 修改上下文
+### updateContext()
 
 比如当前输入行`$ /vue-web-terminal/tzfun > `的 */vue-web-terminal/tzfun* 就是上下文，上下文文本可以由开发者自由设置
 ，但是需使用`.sync`绑定一个变量
@@ -249,22 +253,24 @@ export default {
 </script>
 ```
 
-### Fullscreen
+### fullscreen()
 
 使当前terminal进入或退出全屏
 
 ```js
 Terminal.$api.fullscreen('my-terminal')
 ```
 
+### isFullscreen()
+
 判断当前是否处于全屏状态
 
 ```js
 //  true or false
 let fullscreen = Terminal.$api.isFullscreen('my-terminal')
 ```
 
-### 拖拽
+### dragging()
 
 当开启[拖拽功能](#拖拽功能)时可以使用下面这种方式模拟拖拽来改变窗口位置，其中参数`x`
 是terminal左边框到浏览器可视范围左边框的距离，单位px，`y`是terminal上边框到浏览器可视范围上边框的距离。
@@ -276,15 +282,15 @@ Terminal.$api.dragging('my-terminal', {
 })
 ```
 
-### 执行命令
+### execute()
 
 可以使用api向Terminal执行一个命令，执行过程会回显在Terminal窗口中，这是一种用脚本模拟用户执行命令的方式
 
 ```js
 Terminal.$api.execute('my-terminal', 'help :local')
 ```
 
-### 获取位置
+### getPosition()
 
 当处于拖拽模式时，此接口可获取窗口所在位置
 
@@ -293,6 +299,14 @@ let pos = Terminal.$api.getPosition('my-terminal')
 console.log(pos.x, pos.y)
 ```
 
+### focus()
+
+获取输入焦点
+
+```js
+Terminal.$api.focus('my-terminal')
+```
+
 ## 消息对象
 
 本插件定义了消息对象，任何消息需按照此格式定义才能正确显示。

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-web-terminal",
-  "version": "3.0.10",
+  "version": "3.0.11",
   "description": "网页端命令行插件，适配vue3",
   "license":"Apache-2.0",
   "private": false,