Skip to content

Commit 66c23eb

Browse files
committed
update README.md
1 parent 1c68f17 commit 66c23eb

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Terminal tag supports attribute parameter table.
125125
| command-store-sort | Command line library sorting function. | function | function(a,b) |
126126
| input-filter | Custom input filter, the return value is the filtered string. | function | function(当前输入字符char, 输入框内字符串value, input事件event) |
127127
| drag-conf | Drag and drop window configuration items. | object | [Drag](#Drag) |
128-
128+
| command-formatter | Command display formatting function, pass in the current command and return a new command, support html | function | function(cmd) |
129129
## Events
130130

131131
Terminal tag support event table

README_ZH.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -107,24 +107,25 @@ body, html, #app {
107107

108108
terminal标签支持属性参数表
109109

110-
| 参数 | 说明 | 类型 | 默认值 |
111-
|-----------------------|--------------------------------------------------|----------|--------------------------------------------------|
112-
| name | Terminal实例名称,同一页面的name必须唯一,Api中使用也需用到此值 | string | terminal |
113-
| context | 初始化上下文文本 | string | /vue-web-terminal |
114-
| title | header中显示的标题 | string | vue-web-terminal |
115-
| show-header | 是否显示header,此开关会影响拖拽功能 | boolean | true |
116-
| init-log | Terminal初始化时显示的日志,是由[消息对象](#消息对象)组成的数组,`null`不显示 | array ||
117-
| init-log-delay | 初始化显示日志时每条日志之间的间隔时间,单位毫秒 ms | number | 150 |
118-
| show-log-time | 当消息**type**`normal`时是否显示时间 | boolean | true |
119-
| warn-log-byte-limit | 当前Terminal日志占用内存大小超出此限制会发出警告,单位`byte` | number | 1024 * 1024 * 10 |
120-
| warn-log-count-limit | 当前Terminal日志条数超出此限制会发出警告 | number | 200 |
121-
| warn-log-limit-enable | 是否开启日志限制警告 | boolean | true |
122-
| auto-help | 是否打开命令行自动搜索提示功能 | boolean | true |
123-
| enable-example-hint | 是否显示样例提示 | boolean | true |
124-
| command-store | 自定义的命令库,搜索提示功能会扫描本库,见[命令定义格式](#命令定义) | array | [内置命令](#内置命令) |
125-
| command-store-sort | 命令行库排序 | function | function(a,b) |
126-
| input-filter | 自定义输入过滤,返回值为过滤后的字符串 | function | function(当前输入字符char, 输入框内字符串value, input事件event) |
127-
| drag-conf | 拖拽窗口配置项 | object |[拖拽功能](#拖拽功能) |
110+
| 参数 | 说明 | 类型 | 默认值 |
111+
|-----------------------|--------------------------------------------------|-----------|--------------------------------------------------|
112+
| name | Terminal实例名称,同一页面的name必须唯一,Api中使用也需用到此值 | string | terminal |
113+
| context | 初始化上下文文本 | string | /vue-web-terminal |
114+
| title | header中显示的标题 | string | vue-web-terminal |
115+
| show-header | 是否显示header,此开关会影响拖拽功能 | boolean | true |
116+
| init-log | Terminal初始化时显示的日志,是由[消息对象](#消息对象)组成的数组,`null`不显示 | array ||
117+
| init-log-delay | 初始化显示日志时每条日志之间的间隔时间,单位毫秒 ms | number | 150 |
118+
| show-log-time | 当消息**type**`normal`时是否显示时间 | boolean | true |
119+
| warn-log-byte-limit | 当前Terminal日志占用内存大小超出此限制会发出警告,单位`byte` | number | 1024 * 1024 * 10 |
120+
| warn-log-count-limit | 当前Terminal日志条数超出此限制会发出警告 | number | 200 |
121+
| warn-log-limit-enable | 是否开启日志限制警告 | boolean | true |
122+
| auto-help | 是否打开命令行自动搜索提示功能 | boolean | true |
123+
| enable-example-hint | 是否显示样例提示 | boolean | true |
124+
| command-store | 自定义的命令库,搜索提示功能会扫描本库,见[命令定义格式](#命令定义) | array | [内置命令](#内置命令) |
125+
| command-store-sort | 命令行库排序 | function | function(a,b) |
126+
| input-filter | 自定义输入过滤,返回值为过滤后的字符串 | function | function(当前输入字符char, 输入框内字符串value, input事件event) |
127+
| drag-conf | 拖拽窗口配置项 | object |[拖拽功能](#拖拽功能) |
128+
| command-formatter | 命令显示格式化函数,传入当前命令返回新的命令,支持html | function | function(cmd) |
128129

129130
## Events
130131

0 commit comments

Comments
 (0)