更新日志
Eagle Plugin API 更新日志,记录自第一个 Plugin API 版本后的所有重要功能变更。
重要提醒:Eagle 4.0 Build12 预计近期发布,目前尚未正式推出。在此页面看到标注需要 Eagle 4.0 Build12+ 的新 API 功能,请等待正式版本发布后才能使用。
2025年8月21日
💻 App API 增强
新增功能:app.userDataPath 属性 (Eagle 4.0 build12+)
新增
app.userDataPath
属性,返回当前用户数据目录的路径提供快速访问 Eagle 用户数据存储位置的途径
console.log(eagle.app.userDataPath);
// "C:\Users\User\AppData\Roaming\Eagle"
2025年8月19日
📁 Folder API 增强
新增功能:文件夹 parent 属性可修改 (Eagle 4.0 build12+)
新增
folder.parent
属性修改支持,允许动态调整文件夹层级结构支持将文件夹移动到不同父目录或根目录
// 移动到其他父文件夹
folder.parent = 'parent_folder_id';
await folder.save();
// 移动到根目录
folder.parent = null;
await folder.save();
新增功能:文件夹 iconColor 属性可修改 (Eagle 4.0 build12+)
将
folder.iconColor
属性从只读变更为可修改新增
eagle.folder.IconColor
静态常量对象,提供预定义颜色选项支持的颜色:Red, Orange, Yellow, Green, Aqua, Blue, Purple, Pink
folder.iconColor = eagle.folder.IconColor.Blue;
await folder.save();
2025年8月13日
🏷️ Tag API 功能扩展
新增功能:标签过滤和 Tag 类增强
eagle.tag.get()
方法新增name
参数,支持按名称模糊搜索标签Tag 实例新增
save()
方法,支持修改标签名称新增 Tag 实例属性:
name
(可修改)、count
、color
、groups
、pinyin
// 过滤标签
const filteredTags = await eagle.tag.get({ name: "design" });
// 修改标签名称
tag.name = 'new-name';
await tag.save();
⚠️ 注意:修改标签名称会自动更新所有使用该标签的文件
2025年8月5日
📄 Item API 性能和选择功能大幅增强
新增功能:性能优化
eagle.item.get()
新增fields
参数,支持选择性字段返回,大幅提升查询性能新增
eagle.item.getIdsWithModifiedAt()
方法,专为增量同步优化新增
modifiedAt
属性,记录文件最后修改时间
// 只返回需要的字段
let items = await eagle.item.get({
tags: ["Design"],
fields: ["id", "name", "tags", "modifiedAt"]
});
// 高效增量同步
let fileInfo = await eagle.item.getIdsWithModifiedAt();
新增功能:计数和选择方法
新增
eagle.item.count(options)
- 条件计数新增
eagle.item.countAll()
- 总文件数新增
eagle.item.countSelected()
- 选中文件数新增
eagle.item.select(itemIds)
- 程序化选择文件
let count = await eagle.item.count({ isSelected: true });
await eagle.item.select(['ITEM_ID_1', 'ITEM_ID_2']);
增强功能:open() 方法
eagle.item.open()
新增window
选项,支持在新窗口打开文件
await eagle.item.open('item_id', { window: true });
2025年7月31日
🪟 Window API 扩展
新增功能:窗口几何控制
新增
eagle.window.getSize()
- 获取窗口大小新增
eagle.window.setBounds(bounds)
- 设置窗口边界(位置+大小)新增
eagle.window.getBounds()
- 获取窗口边界信息
await eagle.window.getSize();
await eagle.window.setBounds({ x: 440, y: 225, width: 800, height: 600 });
await eagle.window.getBounds();
2024年11月28日
🏷️ TagGroup CRUD 操作
新增功能:完整的标签分组管理
新增
eagle.tagGroup.create(options)
- 创建新标签分组新增
tagGroup.save()
- 保存修改新增
tagGroup.remove()
- 删除标签分组
// 创建标签分组
await eagle.tagGroup.create({
name: "new group",
color: "red",
tags: ["tag1", "tag2"]
});
// 修改并保存
tagGroup.name = "new name";
await tagGroup.save();
// 删除分组
await tagGroup.remove();
🗑️ Item 删除功能
新增功能:文件回收站操作
新增
item.moveToTrash()
实例方法,将文件移至系统回收站
let item = await eagle.item.getById('item_id');
await item.moveToTrash();
2024年7月25日
🪟 Window API 增强
新增功能:HTTP Referer 设置
新增
eagle.window.setReferer(url)
方法,为后续网络请求设置 referer header
eagle.window.setReferer("https://example.com");
2024年5月10日
🖱️ Context Menu API
新增功能:自定义右键菜单
新增
eagle.contextMenu.open()
方法,支持自定义右键菜单支持多层级子菜单、自定义点击事件、系统原生样式
eagle.contextMenu.open([
{
id: "edit",
label: "编辑",
submenu: [...],
click: () => { ... }
}
]);
🪟 Window API 截图功能
新增功能:页面截图
新增
eagle.window.capturePage(rect)
方法,支持全屏或指定区域截图返回 NativeImage 对象,可转换为 base64 或 PNG buffer
// 全屏截图
const image = await eagle.window.capturePage();
// 指定区域截图
const image2 = await eagle.window.capturePage({
x: 0, y: 0, width: 100, height: 50
});
2024年4月17日
🔍 预览插件功能增强
新增功能:缩放控制参数
预览插件配置新增
allowZoom
参数,控制是否允许用户缩放预览内容
"thumbnail": {
"path": "thumbnail/icns.js",
"size": 400,
"allowZoom": false
}
最后更新于