MorJS 插件示例 插件源代碼示例

2024-01-28 09:16 更新
  • 如果插件需要有設置參數,請務必將 optionsinterface export 出去,方便可能需要集成的使用方引用
  • 插件需要聲明為一個 class,同時實現(xiàn) MorJSPlugin 這個 interface
  • 插件必須要有 apply 函數
  • 插件調用方不能保證 apply 函數里面的 this 指向,因此建議都 class 下面的方法都用箭頭函數,避免 this 指向問題
  • hook 里面的監(jiān)聽函數必須用普通函數,因為在 hook 調用的時候會動態(tài)修改 this 指向,指向當前的 app、page、component 實例
import type { MorJSPlugin, MorJSHooks } from '@morjs/api'

// export 出去,方便使用方集成
export interface IRuntimePluginExampleOptions {}

export default class RuntimePluginExample implements MorJSPlugin {
  // 必須要有插件名字
  pluginName = 'RuntimePluginExample'

  options: IRuntimePluginExampleOptions

  /**
   * 根據插件特性決定是否需要開放選項配置
   */
  constructor(public options: IRuntimePluginExampleOptions = {}) {}

  /**
   * 必須要有 apply 函數
   * class 下面的方法用 arrow function
   */
  apply = (hooks: MorJSHooks): void => {
    // 注意,這里是 arrow function

    // hooks 里面包含上面生命周期列表中的所有hook
    // 請用 tap 來做 hook 的事件監(jiān)聽注冊
    // 傳入的插件執(zhí)行函數必須是 function(){}, 因為會動態(tài)修改 this 指向
    hooks.appOnLaunch.tap(
      this.pluginName,
      function (
        this: tinyapp.IAppInstance<any>,
        options: tinyapp.IAppLaunchOptions
      ) {
        // 這里可以拿到對應生命周期里面的參數
        console.log(options)
      }
    )
  }
}


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號