动态指令

很多时候，插件应用中会提供一些功能供用户进行个性化设置（例如：网页快开插件应用），这部分配置无法在 plugin.json 事先定义好，所以我们提供了以下方法对插件应用功能进行动态增减。

utools.getFeatures([codes])

获取插件应用动态创建的功能。

类型定义

function getFeatures(codes?: string[]): Feature[];

• codes 要获取的功能编码集合

Feature 类型定义

interface Feature {
  code: string;
  explain?: string;
  icon?: string;
  platform?: string | string[];
  mainHide?: boolean,
  mainPush?: boolean,
  cmds: Cmd[];
}

字段说明

• code
  • 功能编码，进入插件应用会将该编码带入，根据不同编码实现功能区分执行。（可参考 plugin.json 中 feature.code）
• explain
  • 功能描述（可参考 plugin.json 中 feature.explain）
• icon
  • 功能图标（可参考 plugin.json 中 feature.icon）
• platform
  • 指定功能可用平台（可参考 plugin.json 中 feature.platform）
• mainHide
  • 若配置为true，打开此功能不主动显示搜索框。（可参考 plugin.json 中 feature.mainHide）
• mainPush
  • 是否向搜索框推送内容。（可参考 plugin.json 中 feature.mainPush）
• cmds
  • 指令集合（可参考 plugin.json 中 feature.cmds）

示例代码

// 获取所有动态功能
const features = utools.getFeatures();
console.log(features);
// 获取特定 code
const features = utools.getFeatures(["code-1", "code-2"]);
console.log(features);

utools.setFeature(feature)

为本插件应用动态新增某个功能。

类型定义

function setFeature(feature: Feature): void;

• feature 类型参考 Feature 类型定义

示例代码

utools.setFeature({
  code: Date.now().toString(),
  explain: "测试动态功能",
  // "icon": "res/xxx.png",
  // "icon": "data:image/png;base64,xxx...",
  // "platform": ["win32", "darwin", "linux"]
  cmds: ["测试"],
});

utools.removeFeature(code)

动态删除本插件应用的某个功能。

类型定义

function removeFeature(code: string): Boolean;

• code 要删除的功能编码

示例代码

utools.removeFeature("code");