评论
如何在 Sketch 中创建和自定义插件
已编辑 2 几个月前 通过 ExtremeHow 编辑团队
翻译更新 2 几个月前
Sketch 是一款流行的设计工具，允许设计师创建美观的用户界面设计。Sketch 的一个关键优势是通过插件实现的可扩展性。插件可以帮助自动化任务、添加新功能以及更好地将 Sketch 的功能适配到您的设计工作流程中。本详细指南将向您介绍在 Sketch 中创建插件和自定义插件的过程。
理解基本概念
在深入插件创建之前，重要的是了解插件是什么以及它们为何有用。Sketch 中的插件本质上是与 Sketch 的 API 交互以执行某些任务的脚本。任务可以从简单的更改颜色到创建完整的 UI 组件等复杂任务。
Sketch API 允许开发人员与文档、页面、图层等交互，使得构建强大的工具成为可能。这些工具有助于简化设计流程，节省时间和精力。
设置您的环境
在开始创建插件之前，您需要设置开发环境。以下是开始的步骤：
- 安装 Sketch：确保在您的计算机上安装了最新版本的 Sketch。Sketch 目前可用于 macOS。
- 设置文本编辑器：一个好的文本编辑器对于编写代码至关重要。一些流行的选项有 Visual Studio Code、Sublime Text 和 Atom。选择您觉得最舒适的一个。
- 熟悉 JavaScript：Sketch 插件是用 JavaScript 编写的，所以对 JavaScript 的基本了解是必要的。学习 JavaScript 语法、变量、函数和对象的基础知识是一个不错的开始。
创建一个简单的 Sketch 插件
现在我们开始创建一个简单的 Sketch 插件。这个例子将向您展示如何创建一个插件，将一个红色矩形添加到您的 Sketch 文档中。
步骤 1：创建您的插件文件夹
首先创建一个新的文件夹，为您的插件取一个有意义的名字，例如“RedRectanglePlugin”。这个文件夹将包含插件所需的所有文件。
步骤 2：创建清单文件
manifest.json 文件告诉 Sketch 有关您插件的信息。它包含插件的名称、版本和要执行的脚本等信息。
{
"name": "Red Rectangle Plugin",
"identifier": "com.example.redrectangleplugin",
"version": "1.0",
"description": "一个简单的 Sketch 插件，用于添加一个红色矩形。",
"author": "您的名字",
"commands": [
{
"name": "添加红色矩形",
"identifier": "addRedRectangle",
"script": "./addRedRectangle.js"
}
]
}
将 manifest.json 文件放入您的插件文件夹中。
步骤 3：编写插件脚本
在插件文件夹内创建一个名为 addRedRectangle.js 的新 JavaScript 文件。这个脚本将向 Sketch 中的现有页面添加一个红色矩形。以下是一个简单的例子：
function onAddRedRectangle(context) {
var sketch = require('sketch/dom');
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
// 创建一个新的矩形
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: 100, height: 100 },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
module.exports = onAddRedRectangle;
将此脚本保存在您的插件文件夹中。
步骤 4：安装并测试您的插件
要安装您的插件，请按照以下步骤操作：
- 打开 Sketch。
- 转到 插件 > 管理插件...
- 点击齿轮图标并选择 显示插件文件夹。
- 将您的插件文件夹复制到显示的插件文件夹中。
- 重启 Sketch 或 转到 插件 > 运行脚本 > 重新加载插件。
- 您的插件现在应该出现在插件菜单中！
测试：打开任何 Sketch 文档，转到 插件 > 红色矩形插件 > 添加红色矩形。您应该会看到一个红色矩形出现在画布上。
自定义您的插件
现在您已经创建了一个简单的插件，让我们看看如何进一步自定义它。
添加用户设置
有时，您可能希望用户能够配置插件的工作方式。为此，您可以使用 Sketch 的内置工具创建设置的用户界面。
function onAddRectangleWithSettings(context) {
var sketch = require('sketch/dom');
var UI = require('sketch/ui');
UI.getInputFromUser(
"矩形大小",
{ type: UI.INPUT_TYPE.string, initialValue: "100" },
(err, value) => {
if (err) { return; }
var document = sketch.getSelectedDocument();
var page = document.selectedPage;
var size = parseInt(value, 10);
var rectangle = new sketch.Rectangle({
parent: page,
frame: { x: 0, y: 0, width: size, height: size },
style: { fills: [{ color: '#FF0000', fillType: 'Color' }] }
});
page.layers.push(rectangle);
}
);
}
module.exports = onAddRectangleWithSettings;
在这个例子中，当您运行插件时，它会请求用户输入对矩形的偏好大小。
使用第三方库
有时，默认的 Sketch API 可能不足以实现您的目标。您可能希望使用第三方 JavaScript 库来扩展功能。
以下是如何使用第三方库的方法：
- 选择一个库并下载其 JavaScript 文件。
- 将文件包含在您的插件文件夹中。
- 使用
require()在脚本中包含和使用它。
var _ = require('./lodash.min.js');
function main(context) {
var numbers = [1, 2, 3, 4, 5];
var doubled = _.map(numbers, function(n) {
return n * 2;
});
console.log(doubled);
}
module.exports = main;
在这个例子中，我们使用了 Lodash 库来将一组数字加倍。
测试和调试
与任何其他软件开发一样，测试和调试在插件开发中也非常重要。以下是一些提示：
- 控制台日志：使用
console.log()将变量和输出打印到控制台，可以通过 插件 > 运行脚本 > 显示工具 > 显示控制台 在 Sketch 中查看。 - 拆分脚本：将脚本分解为更小、更易管理的任务。这使得更容易找出问题所在。
- 模拟数据：使用模拟数据独立于 Sketch 环境测试插件的功能。
发布您的插件
一旦您对插件满意，您可能希望与社区分享它。以下是发布您插件的方法：
- 准备文档：创建一个
README.md文件，其中包含有关如何安装和使用您的插件的说明。为任何特定设置提供代码和解释。 - 为您的代码选择许可证：为您的代码选择适当的许可证。许多开发者使用 MIT 许可证或 Apache 许可证。
- 托管您的插件：使用 GitHub 这样的平台托管您的插件源码。这使其对他人可访问并使他们有机会贡献。
- 提交到 Sketch 插件目录：您可以将您的插件提交到 Sketch 的插件目录中以获得更多的可见性。确保遵循目录指南。
结论
在 Sketch 中创建和自定义插件可以极大地扩展其功能，并根据您的特定需求进行调整。通过遵循本指南，您已经学习到了如何设置环境、创建基础插件、进行自定义、使用第三方库，甚至发布创作。通过实践和创造力，您可以对 Sketch 插件生态系统做出重要贡献，让设计过程更加高效和创新。快乐编程！
如果你发现文章内容有误, 您可以