10 脚本
激活脚本
想要在 Sketch 中激活脚本,在菜单中选择“ Sketch > 首选项(Preferences...
)”,选中“通用(General
)”选项卡,并点击“启用脚本(Enable Scripting
)”。一个新的叫做“插件(Plugins
)”的菜单项会出现在菜单条中。在这里,通过点击“自定义脚本(Custom Script...
)”你可以开始写你自己的脚本。
安装脚本
脚本文件应该有 .jstalk
扩展名,并且放在 ~/library/application support/sketch/plugins
文件夹下。如果你正在运行的 Sketch 是通过 App Store 安装的,它会处于沙盒中,相应地你的脚本需要放在 ~/Library/Containers/com.bohemiancoding.sketch/Data/Library/Application Support/sketch/Plugins
下。
接下来,插件会显示在 Sketch 的插件菜单中。插件的名字是文件名,你甚至可以给它设一个自定义的快捷键。
语法
要了解更多关于 JSTalk 的信息和它的语法,访问 JSTalk.org 。
前文
Sketch 会在每一个运行的脚本前面添加下面的代码片段。通过这种方式,你可以放问到常用的变量。
var doc = [[NSDocumentController sharedDocumentController] currentDocument];
var selection = doc.selectedLayers();
快捷键
你可以为插件的菜单项设置一个快捷键。方法如下:第一行应该是注释,用来解释这个脚本的用途。在第一行的某个地方,你可以在括号之间放置快捷键。例如:
// just a comment (cmd y) // (ctrl alt cmd t)
最后一个字符是快捷键,它前面是要按下的组合键。下面的组合键都是有效的:
control ctrl alt option cmd command shift
注意,一旦你安装了一个插件,你可以通过“插件 > 自定义脚本(Plugins> Custom Script
)”菜单来运行任意的自定义脚本。
实例
我们认为,相对于展示头文件,通过提供实例来解释 API 的用法更好。如下:
全部实例也都可以在 GitHub 下载到。
要求用户输入
通过以下方法,脚本可以提示用户进行输入。返回值是字符串——可以很容易转换为整形或浮点型数值。两个参数是必须的:一个短标签来提示用户,以及输入区的默认值:
[doc askForUserInput:"How many times?" initialValue:10];
参见 用户输入示例 中的实际用法
API
- MSDocument
- MSContentDrawView
- MSLayer
- MSLayerGroup
- MSRect
- MSStyle
- MSPage
- MSDocument
- MSArtboardGroup
- MSSliceLayer
以上的任意一个脚本都可以保存为 .jstalk 文件,放进之前提到的文件夹下,它们会工作得很好。
第三方脚本
要找到更多的 Sketch 脚本,可以看看 @bomberstudios 建立的代码库,如下:
要了解 API 的重大修改,请查看 changelog 。