SuperAPI AI 工具集

component-api-design

编程与开发

查看项目

更新于 10-15 21:12

技能介绍

用途:为设计系统设计组件 API、prop 接口与开发者体验,帮助团队在组件层面建立一致、可预测、易用的接口规范。

主要能力:资料给出若干设计原则,包括一致命名(同一 prop 名在各组件中含义相同)、合理默认值(最常见用法无需传任何 prop)、组合优于配置(优先使用 children/slots,而非庞大的 prop 对象)、类型安全(所有 props 使用 TypeScript 接口)、文档(每个 prop 都有描述与示例)。

命名约定:variant 为字符串联合类型,如 'primary'、'secondary'、'ghost';size 为字符串联合类型,如 'sm'、'md'、'lg';disabled 为布尔值 true/false;onAction 为函数,采用 on + PascalCase 事件命名;className 为字符串,用于自定义 CSS 类;children 为 ReactNode,表示组件内容;asChild 为布尔值,用于渲染为子元素。

反模式:用布尔 prop 控制不相关的事情;prop 之间互相冲突;prop 数量超过 10-12 个(说明组件职责过多);本可用联合类型却使用字符串 prop。

使用方式与限制:资料未提供具体安装命令、代码示例或平台信息,暂未提供。该技能适用于设计系统与组件库的接口设计评审,具体落地需结合项目技术栈自行判断。