Skip to content

Commit e890684

Browse files
committed
更新文档:1. 添加隐藏变量选择和隐藏虚拟键盘的使用说明;2. 说明通过属性和设置面板控制隐藏功能的方法;3. 提及属性控制优先级的注意事项。
1 parent b7c3408 commit e890684

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

README.en.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,27 @@ The editor supports both Chinese and English interfaces:
376376

377377
Note: Language setting affects all interface text in the editor, including button labels, tooltips, and error messages.
378378

379+
## Hide Features Usage
380+
381+
The editor provides the ability to hide the variable selection area and virtual keyboard. This can be controlled in two ways:
382+
383+
1. Direct control through props:
384+
385+
```vue
386+
<ExpressionEditor
387+
:hide-variables="true"
388+
:hide-keyboard="true"
389+
/>
390+
```
391+
392+
2. Control through the settings panel:
393+
394+
- Click the settings button to open the settings panel
395+
- Toggle the "Hide Variable Selection" and "Hide Virtual Keyboard" options
396+
- Settings will be automatically saved to local storage
397+
398+
Note: The hide state controlled by props takes precedence over the options in the settings panel. If you want users to freely control the show/hide state, it's recommended not to force control through props.
399+
379400
## Usage Tips
380401

381402
1. Keyboard Shortcuts:

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,27 @@ interface Variable {
376376

377377
注意:语言设置会影响整个编辑器的界面文本,包括按钮文本、提示信息和错误消息等。
378378

379+
## 隐藏功能使用说明
380+
381+
编辑器提供了隐藏变量选择区域和虚拟键盘的功能,可以通过以下两种方式控制:
382+
383+
1. 通过属性直接控制:
384+
385+
```vue
386+
<ExpressionEditor
387+
:hide-variables="true"
388+
:hide-keyboard="true"
389+
/>
390+
```
391+
392+
2. 通过设置面板控制:
393+
394+
- 点击设置按钮打开设置面板
395+
- 切换"隐藏变量选"和"隐藏虚拟键盘"选项
396+
- 设置会自动保存到本地存储
397+
398+
注意:通过属性控制的隐藏状态优先级高于设置面板中的选项。如果需要让用户可以自由控制显示/隐藏状态,建议不要通过属性强制控制。
399+
379400
## 使用技巧
380401

381402
1. 快捷键支持:

0 commit comments

Comments
 (0)