Skip to content

Sketch

Sketch 是一款专为 macOS 设计的矢量图形编辑器,主要用于用户界面和图标设计。Protocol Launcher 允许您生成深度链接以在 Sketch 中打开文件、添加库和运行插件。

使用方式

有两种使用此库的方式:

  • 按需导入(On-Demand):从子路径导入支持 tree-shaking,保持较小的打包体积。
  • 完整导入(Full Import):从根包导入更方便,但会包含所有应用模块。

生产构建建议选择按需导入;快速脚本或演示可以使用完整导入。

选择安装方式

按需加载
推荐使用。生产环境优化。
全量导入
使用便捷。适合快速脚本。

打开 Sketch

On-Demand
ts
import { open } from 'protocol-launcher/sketch'

const url = open()

打开文件

On-Demand
ts
import { openFile } from 'protocol-launcher/sketch'

const url = openFile({
  path: '/Users/name/Documents/design.sketch',
})

打开文件并聚焦图层和缩放

On-Demand
ts
import { openFile } from 'protocol-launcher/sketch'

const url = openFile({
  path: '/Users/name/Documents/design.sketch',
  centerOnLayer: 'layer-123',
  zoom: 2,
})

添加库

On-Demand
ts
import { addLibrary } from 'protocol-launcher/sketch'

const url = addLibrary({
  url: 'https://developer.apple.com/design/downloads/sketch.rss',
})

运行插件

On-Demand
ts
import { runPlugin } from 'protocol-launcher/sketch'

const url = runPlugin({
  pluginId: 'com.example.sketch.messenger',
  commandId: 'message.show',
})

运行插件并传递参数

On-Demand
ts
import { runPlugin } from 'protocol-launcher/sketch'

const url = runPlugin({
  pluginId: 'com.example.sketch.messenger',
  commandId: 'message.show',
  query: { msg: 'Hello World' },
})