Action API

目录

1. 入门

   1. 插件基础
   2. 您的第一个插件
   3. 开发环境
   4. 调试
   5. Action API
   6. 发布插件

2. 高级

   1. 插件捆绑
   2. 插件，脚本和命令
   3. 插件位置
   4. 更多关于CocoaScript
   5. SketchTool

---

在Sketch 3.8中，我们引入了Action API：一种让插件对应用程序中的事件作出反应的方式。使用它，插件作者可以编写在触发某些操作时执行的代码，如“打开文档”，“保存”，“添加画板”......

什么是操作(Action)？

操作是应用程序中发生的事件，通常是用户交互的结果。操作有名称CloseDocument，DistributeHorizontally或者TogglePresentationMode，你可以告诉你的插件在这些操作被触发时运行代码。

我如何注册我的插件来“聆听”一个操作？

简单：你只需在manifest.json你的插件已有的文件中添加一个处理程序。

我们将为该OpenDocument操作添加一个新的处理程序：

"commands" : [
  ...
+  {
+    "script" : "my-action-listener.js",
+    "name" : "My Action Listener",
+    "handlers" : {
+      "actions": {
+        "OpenDocument": "onOpenDocument"
+      }
+    },
+    "identifier" : "my-action-listener-identifier"
+  }
  ...
],

我们告诉我们的插件，我们希望onOpenDocument在文档打开时运行该功能，所以让我们将其添加到my-action-listener.js：

export function onOpenDocument(context) {
  context.document.showMessage('Document Opened')
}

保存所有内容，构建插件，现在，无论何时在Sketch中打开文档，您都应该看到一个小小的吐司(Toast)横幅，上面写着“文档已打开”。

行动上下文

当一个操作被触发时，Sketch可以向目标函数发送一些关于操作本身的信息（例如选择改变时选择的图层，或者打开新文档时的当前文档）。我们称之为操作上下文，并且可以使用context作为目标函数的参数发送的操作context.actionContext。

但请记住，并非所有操作都会设置Action Context。事实上，他们中的大多数目前都没有，所以如果您认为您想在Action Context中访问某些内容，请向我们发送便条，然后尽快添加。

begin/ finish行动

一些行动（如SelectionChanged）实际上发生在两个阶段：begin和finish。如果你想调用一个函数只对其中的一个，你可以添加一个处理程序SelectionChanged.begin，或SelectionChanged.finish。如果您不添加任何内容，该操作将被触发两次。

找到正确的行动

有关API中所有可用操作的列表，请查看操作参考部分。

专业提示：有时浏览列表的工作量太大，而您只想要更直接一些。对于这些情况，您可以听取所有操作以找到您需要的一个。

再次，如果有任何事件想要添加到列表中，请告诉我们，我们将尝试添加它（由于性能原因，某些事件不在列表中，例如“图层被拖动”）。

下一步

如果您想更详细地了解Action API，请尝试以下主题：

• Action API参考 - 了解可用操作的完整列表。
• 其他插件示例 - 查看我们的示例插件项目列表。

原文：https://developer.sketchapp.com/guides/action-api/