Plugin API
繁體中文
繁體中文
  • 入門
    • 簡介
    • 你的第一個插件
    • 檔案結構概述
    • 插件類型
      • 視窗
      • 背景服務
      • 格式擴充
      • 檢查器
    • 除錯插件
  • 部署
    • 準備插件
    • 打包插件
    • 發佈插件
    • 更新插件
    • 開發者政策
    • 插件圖示樣板
  • 開發指南
    • manifest.json 完整設定
    • 取得數據
    • 修改數據
    • 存取本機檔案
    • 發出網路請求
    • 使用 Node.js 原生 API
    • 使用第三方模快
    • 多國語言(i18n)
    • 無邊框視窗
  • API 參考
    • event(事件)
    • item(項目)
    • folder(資料夾)
    • tag(標籤)
    • tagGroup(標籤群組)
    • library(資源庫)
    • window(視窗)
    • app(應用)
    • os(作業系統)
    • screen(螢幕)
    • notification(通知)
    • contextMenu(右鍵選單)
    • dialog(對話框)
    • clipboard(剪貼板)
    • drag(拖曳檔案)
    • shell(殼)
    • log(日誌)
  • 额外组件
    • FFmpeg
Powered by GitBook
On this page
  • onPluginCreate(callback)
  • onPluginRun(callback)
  • onPluginBeforeExit(callback)
  • onPluginShow(callback)
  • onPluginHide(callback)
  • onLibraryChanged(callback)
  • onThemeChanged(callback)
  1. API 參考

event(事件)

你可以根據需要,事先定義好一些回調函數,Eagle 會在事件產生時主動調用它們。

onPluginCreate(callback)

插件視窗建立時,Eagle 會主動調用這個方法,你可以使用此方法初始化插件需要的模組。

  • callback Function

    • plugin Object - 插件屬性

      • manifest Object - 插件 manifest.json 完整設定。

      • path String - 插件所在路徑

eagle.onPluginCreate((plugin) => {
    console.log(plugin.manifest.name);
    console.log(plugin.manifest.version);
    console.log(plugin.manifest.logo);
    console.log(plugin.path);
});

提示:如果插件不需要 manifest 資訊就可以運行,那麼你也可以使用 window.onload 來進行開發。

onPluginRun(callback)

當使用者點擊插件面板的插件時,Eagle 會主動調用這個方法。

  • callback Function

eagle.onPluginRun(() => {
    console.log('eagle.onPluginRun');
});

onPluginBeforeExit(callback)

插件視窗關閉前 Eagle 會主動調用這個方法。

  • callback Function

eagle.onPluginBeforeExit(() => {
    console.log("插件將退出");
});

// 阻止視窗關閉
window.onbeforeunload = (event) => {
    return event.returnValue = false;
};

提示:如果你想要阻止視窗被關閉,你可以註冊 window.onbeforeunload方法避免視窗被關閉。

onPluginShow(callback)

插件視窗顯示時時,Eagle 會主動調用這個方法。

  • callback Function

eagle.onPluginShow(() => {
    console.log("插件視窗顯示");
});

onPluginHide(callback)

插件視窗隱藏時時,Eagle 會主動調用這個方法。

  • callback Function

eagle.onPluginHide(() => {
    console.log("插件視窗隱藏");
});

onLibraryChanged(callback)

當使用者切換資源庫時,Eagle 會主動調用這個方法。

  • callback Function

    • libraryPath String - 當前資源庫路徑。

eagle.onLibraryChanged((libraryPath) => {
    console.log(`偵測到資源庫切換,新的資源庫路徑: ${libraryPath}`);
});

提示:如果你需要獲取更完整的資源庫資訊,你可以使用 eagle.library.info() 方法取得。

注意: 如果插件執行過程必須依賴相對的資源庫路徑,你可能需要透過註冊此方法,在資源庫切換時,做出對應的調整,避免程式執行過程發生錯誤。

onThemeChanged(callback)

Eagle 主程式主題配色改變是,Eagle 會主動調用這個方法,如果插件支援多種配色主題,你可以使用此方法做出對應的 UI 調整。

  • callback Function

    • theme String - 當前主題配色的名稱,如 Auto、LIGHT、LIGHTGRAY、GRAY、DARK、BLUE、PURPLE。

eagle.onThemeChanged((theme) => {
    console.log(`配色主題以改為: ${theme}`);
});

Previous無邊框視窗Nextitem(項目)

Last updated 1 year ago