关于 component-properties-figma
component-properties-figma 是用于定义 Figma 组件属性并将其应用于实例的技能。它涵盖属性 API 的编写,以及通过脚本创建或更新组件实例。
主要功能
- 01添加、编辑和删除组件属性
- 02支持 TEXT、BOOLEAN、INSTANCE_SWAP 和 VARIANT
- 03实例化组件并选择变体
- 04设置现有实例的覆盖值
- 05验证属性定义
适用场景
- 01为组件开放可配置项
- 02创建指定变体的组件实例
- 03通过属性更新文本或可见性
- 04替换插槽中的组件实例
MCP 相关
该技能通过脚本执行 Figma 设计系统写入;它涵盖原生 MCP 的只读 get_design_context 和 get_metadata 未提供的编写操作。
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ southleft/ skills-for-figma --skill component-properties-figma安装后在 Claude Code 中输入/component-properties-figma确认已加载。
附带文件scripts/add-property.jsscripts/instantiate-and-set.js
详细介绍
component-properties-figma — 定义组件的 API 并创建其实例
两个相关任务:
- 编写组件的属性 API — 添加、编辑或删除
TEXT、BOOLEAN、INSTANCE_SWAP和VARIANT属性,让组件提供恰当的可调选项(相当于 Figma 中 React 组件的 props)。 - 使用组件 — 创建实例并设置其属性(标签文本、布尔开关、变体选择、替换子实例)。
技能边界
use_figma规则 — 首先加载官方的figma-use技能;它是完整的 Figma Plugin API 参考。这些脚本依赖的要点:使用普通 JS,支持顶层await和return(不使用 IIFE,也不调用figma.closePlugin();console.log不会作为返回值返回);在每个脚本顶部将输入内联为const;颜色范围为 0–1;执行任何文本操作前先加载字体;使用await figma.getNodeByIdAsync(...);以及原子错误(脚本失败时不会应用任何更改 — 读取错误、修正后重试)。- 读取组件现有属性定义/状态机 →
使用
analyze-component-set-figma或deep-component-figma。 - 这些是设计系统编写操作,原生 MCP 的
get_design_context/get_metadata(只读)无法完成。
属性类型
| 类型 | 控制内容 | defaultValue | 备注 |
|---|---|---|---|
TEXT | 文本图层字符串覆盖值 | "Label" | 在 UI 中绑定到文本节点的字符 |
BOOLEAN | 显示/隐藏图层 | true/false | 绑定到图层的可见性 |
INSTANCE_SWAP | 填充插槽的子组件 | 组件 key | 传入 preferredValues 以填充选择器 |
VARIANT | 变体轴(Size、State…) | 一个选项字符串 | 仅适用于 COMPONENT_SET |
工作流 — 编写属性
- 指定
COMPONENT_SET(或独立的COMPONENT)作为目标。 你不能向单个变体添加属性 — 脚本会报错并提示你使用父级集合。 - 使用
scripts/add-property.js添加(use_figma,skillNames: "component-properties-figma")。设置NODE_ID、PROPERTY_NAME、PROPERTY_TYPE、DEFAULT_VALUE。addComponentProperty会返回带#id后缀的名称 — 请记录下来。 - 通过重复使用同一脚本中的
editComponentProperty(name, {...})/deleteComponentProperty(name)调用来编辑/删除(脚本中提供了注释掉的示例)。编辑/删除非变体属性时,请使用创建时返回的带后缀名称。 - 验证:重新读取
node.componentPropertyDefinitions(脚本会返回该值)。
工作流 — 创建实例并设置实例属性
- 获取组件标识。 已发布库中的
componentKey(首选)和/或本地nodeId。如果两者都有,请同时传入 — 脚本会先尝试导入库组件,再尝试本地节点。 - 运行
scripts/instantiate-and-set.js。设置COMPONENT_KEY/COMPONENT_ID,可选的VARIANT(例如{ Size: "md", State: "default" })、OVERRIDES、POSITION和PARENT_ID。 - 使用同一脚本的
setProperties路径设置现有实例的属性 — 脚本会加载主组件,然后自动匹配普通名称和带Name#id后缀的名称。
备注
- 实例属性键带有
#nodeId后缀,适用于 TEXT/BOOLEAN/INSTANCE_SWAP ("Label#12:3");VARIANT 属性则使用不带后缀的名称。创建实例的脚本会自动解析两种形式,因此你可以传入易读名称(Label),脚本会找到带后缀的键。 - 直接编辑实例的文本图层会无声失败 — 始终通过
setProperties/实例属性操作,不要对嵌套实例文本节点设置.characters。 componentKey仅适用于已发布组件。对于本地/未发布组件,请使用nodeId。
评论
支持 Markdown