思源笔记社区正在搭建中，现邀您共建
SiYuan Community is under construction. Join us to co-build.

事件总线

内容延续自：https://docs.siyuan-note.club/zh-Hans/reference/api/plugin/event-bus/

部分事件于思源特定版本中添加，对应版本请查看上述源链接。

事件总线

总线名称	简介
`click-blockicon`	✅ 块菜单打开事件
`click-editorcontent`	✅ 编辑区点击事件
`click-editortitleicon`	✅ 文档块菜单打开事件
`click-flashcard-action`	✅ 点击闪卡选项事件
`click-pdf`	✅ PDF 注释菜单打开事件
`destroy-protyle`	✅ 编辑器关闭事件
`input-search`	✅ 搜索输入框内容变更事件
`loaded-protyle-dynamic`	✅ 编辑器内容动态加载事件
`loaded-protyle-static`	✅ 编辑器内容静态加载事件
`loaded-protyle`	🚫 编辑器加载事件
`lock-screen`	✅ 锁屏事件
`mobile-keyboard-hide`	✅ 移动端隐藏悬浮键盘
`mobile-keyboard-show`	✅ 移动端显示悬浮键盘
`open-menu-av`	✅ 属性视图右键菜单打开事件
`open-menu-blockref`	✅ 块引用右键菜单打开事件
`open-menu-breadcrumbmore`	✅ 面包屑`更多`菜单打开事件
`open-menu-content`	✅ 文本划选右键菜单打开事件
`open-menu-doctree`	✅ 文档树右键菜单打开事件
`open-menu-fileannotationref`	✅ 附件引用右键菜单打开事件
`open-menu-image`	✅ 图片菜单打开事件
`open-menu-inbox`	✅ 云收集箱右键菜单打开事件
`open-menu-link`	✅ 超链接右键菜单打开事件
`open-menu-tag`	✅ 标签右键菜单打开事件
`open-noneditableblock`	✅ 文本编辑框打开事件
`open-siyuan-url-block`	✅ 打开思源超链接 `siyuan://blocks/` 事件
`open-siyuan-url-plugin`	✅ 打开思源超链接 `siyuan://plugins/` 事件
`paste`	✅ 剪贴板粘贴事件
`switch-protyle`	✅ 编辑器切换事件
`sync-end`	✅ 同步结束事件
`sync-fail`	✅ 同步失败事件
`sync-start`	✅ 同步开始事件
`ws-main`	✅ 编辑事件 & 其他消息事件

✅: 思源最新版本可用

思源最新版本

🧪: 实验性功能

⚠: 强烈反对，在未来可能被移除

🚫: 已移除

`click-blockicon` {#click-blockicon}

块菜单打开事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

`click-editorcontent` {#click-editorcontent}

编辑区点击事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

`click-editortitleicon` {#click-editortitleicon}

文档块菜单打开事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

`click-flashcard-action` {#click-flashcard-action}

点击闪卡选项事件

参考: Issue #10318 · siyuan-note/siyuan · GitHub

`click-pdf` {#click-pdf}

PDF 注释菜单打开事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

`destroy-protyle` {#destroy-protyle}

编辑器关闭事件

参考: Issue #9033 · siyuan-note/siyuan · GitHub

`input-search` {#input-search}

搜索输入框内容变更事件

参考: Issue #8725 · siyuan-note/siyuan · GitHub

`loaded-protyle-dynamic` {#loaded-protyle-dynamic}

编辑器内容动态加载事件

参考: Issue #9021 · siyuan-note/siyuan · GitHub

`loaded-protyle-static` {#loaded-protyle-static}

编辑器内容静态加载事件

参考: Issue #9468 · siyuan-note/siyuan · GitHub

`loaded-protyle` {#loaded-protyle}

编辑器加载事件

参考: Issue #9468 · siyuan-note/siyuan · GitHub

`lock-screen` {#lock-screen}

锁屏事件

参考: Issue #10006 · siyuan-note/siyuan · GitHub

`mobile-keyboard-hide` {#mobile-keyboard-hide}

移动端隐藏悬浮键盘

参考: Issue #9773 · siyuan-note/siyuan · GitHub

`mobile-keyboard-show` {#mobile-keyboard-show}

移动端显示悬浮键盘

参考: Issue #9773 · siyuan-note/siyuan · GitHub

`open-menu-av` {#open-menu-av}

属性视图右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-blockref` {#open-menu-blockref}

块引用右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-breadcrumbmore` {#open-menu-breadcrumbmore}

面包屑更多菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-content` {#open-menu-content}

文本划选右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-doctree` {#open-menu-doctree}

文档树右键菜单打开事件

参考: Issue #9351 · siyuan-note/siyuan · GitHub

`open-menu-fileannotationref` {#open-menu-fileannotationref}

附件引用右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-image` {#open-menu-image}

图片菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-inbox` {#open-menu-inbox}

云收集箱右键菜单打开事件

参考: Pull Request #9967 · siyuan-note/siyuan · GitHub

`open-menu-link` {#open-menu-link}

超链接右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-menu-tag` {#open-menu-tag}

标签右键菜单打开事件

参考: Issue #8617 · siyuan-note/siyuan · GitHub

`open-noneditableblock` {#open-noneditableblock}

文本编辑框打开事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

`open-siyuan-url-block` {#open-siyuan-url-block}

打开思源超链接 siyuan://blocks/ 事件

参考: Pull Request #8927 · siyuan-note/siyuan · GitHub

`open-siyuan-url-plugin` {#open-siyuan-url-plugin}

打开思源超链接 siyuan://plugins/ 事件

参考: Pull Request #8927 · siyuan-note/siyuan · GitHub

`paste` {#paste}

剪贴板粘贴事件

参考: Issue #9452 · siyuan-note/siyuan · GitHub

`switch-protyle` {#switch-protyle}

编辑器切换事件

参考: Issue #9454 · siyuan-note/siyuan · GitHub

`sync-end` {#sync-end}

同步结束事件

参考: Issue #9798 · siyuan-note/siyuan · GitHub

`sync-fail` {#sync-fail}

同步失败事件

参考: Issue #9798 · siyuan-note/siyuan · GitHub

`sync-start` {#sync-start}

同步开始事件

参考: Issue #9798 · siyuan-note/siyuan · GitHub

`ws-main` {#ws-main}

编辑事件 & 其他消息事件

参考: Issue #5066 · siyuan-note/siyuan · GitHub

修改于 2025-06-29 19:07:52

类型与接口