Ribbon API 进阶
Ribbon(左侧边栏图标栏)是插件最显眼的入口。进阶用法包括动态图标、条件显示与右键菜单。
核心要点
添加图标
ts
const ribbon = this.addRibbonIcon("document", "我的插件", () => {
new Notice("点击了 Ribbon");
});
// 自定义标题(悬浮提示)
ribbon.setAttribute("aria-label", "打开我的面板");进阶技巧
- 动态切换:根据状态改图标(
setIcon("check"))或显隐(ribbon.toggleClass("hidden", true)) - 右键菜单:监听
contextmenu事件弹出Menu,提供多个快捷操作 - 条件显示:仅在桌面端(
!this.app.isMobile)或非特定仓库时显示
注意事项
- Ribbon 图标应「少而精」,过多会挤压其他插件空间
- 卸载时
addRibbonIcon已自动清理,无需手动移除