Typora插件自定义快捷键配置指南
在Typora插件项目中,自定义快捷键功能为用户提供了强大的文本处理能力。本文将详细介绍如何通过修改配置文件来实现自定义快捷键功能,让用户能够快速为选中文本应用特定样式或执行自定义操作。
配置文件位置
自定义快捷键的核心配置文件位于插件目录下的plugin/global/settings/hotkey.user.toml
文件中。这个文件专门用于用户自定义的快捷键设置,与系统默认的hotkey.default.toml
文件分开管理,避免用户修改被系统更新覆盖。
配置语法解析
配置文件采用TOML格式,每个快捷键配置都是一个独立的配置块,包含以下几个关键参数:
- desc:快捷键的功能描述,会显示在快捷键帮助中
- enable:是否启用该快捷键,设置为true表示启用
- hotkey:定义具体的快捷键组合,如"ctrl+alt+j"
- evil:包含实际执行的JavaScript代码
实际配置示例
以下是一个完整的为选中文本添加引号的快捷键配置示例:
[wrapQuotationMarks]
desc = "包裹引号"
enable = true
hotkey = "ctrl+alt+j"
evil = """
() => {
const {node, bookmark, range} = this.utils.getRangy();
const ele = File.editor.findElemById(node.cid);
const rangyText = ele.rawText().substring(bookmark.start, bookmark.end);
if (rangyText !== "") {
const insertText = "“" + rangyText + "”";
File.editor.UserOp.pasteHandler(File.editor, insertText, true, true, true);
File.editor.undo.addSnap(node.cid, File.editor.undo.UndoManager.SnapFlag.REPLACE);
setTimeout(() => {
const {range, bookmark} = this.utils.getRangy();
bookmark.start -= insertText.length - 1;
bookmark.end -= 1
range.moveToBookmark(bookmark);
range.select();
});
}
}
"""
代码功能解析
- 获取选区内容:通过
this.utils.getRangy()
获取当前选中的文本范围和相关DOM节点信息 - 文本处理:提取选中文本内容,并在其前后添加中文引号
- 替换选区:使用
pasteHandler
方法用处理后的文本替换原选区 - 撤销支持:添加撤销快照,确保操作可通过Ctrl+Z撤销
- 选区恢复:调整选区位置,使其仅选中新添加的引号内的内容
高级应用技巧
- 无选区时的处理:可以在代码中添加判断,当没有选中文本时,直接插入预设的样式模板
- 多样式组合:可以设计更复杂的样式组合,如同时添加引号和改变字体颜色
- 条件判断:根据选区内容的不同特征执行不同的样式处理
- 外部数据引用:可以从其他配置文件中读取样式模板,实现样式与快捷键的分离管理
注意事项
- 修改配置文件后需要重启Typora或重新加载插件才能生效
- 复杂的JavaScript代码建议先在浏览器控制台测试后再写入配置文件
- 快捷键冲突时,后加载的配置会覆盖先加载的配置
- 建议定期备份自定义的快捷键配置
通过灵活运用这些配置技巧,用户可以极大地提升在Typora中的编辑效率,实现一键应用各种复杂样式和文本处理操作。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考