SuperAPI AI 工具集

guidance-api-design

前端与建站

查看项目

更新于 10-16 02:34

技能介绍

用途:该技能用于指导组件 API 的设计与修改,要求在动手设计或改动组件 API 前先查阅相关的 API 设计指南,确保符合 Elements 约定。

主要能力与覆盖主题:

  • 为新组件设计 properties 与 attributes;
  • 创建用于主题化的 CSS 自定义属性;
  • 避免组件 API 中出现不可能状态;
  • 在 properties、attributes 与 slots 之间做选择;
  • 设计自定义事件;
  • 规划组件组合模式;
  • 设置包导出与依赖。

使用方式:按任务类型查阅对应指南,包括无状态组件(Stateless Components)、属性与特性(Properties & Attributes)、样式与 CSS 自定义属性(Styles & CSS Custom Properties)、组件组合(Component Composition)、插槽(Slots)、自定义事件(Custom Events)、组件注册(Component Registration)、打包与导出(Packaging & Exports)。当创建可能包含用户状态的新组件或功能时,应查阅无状态组件指南;处理 JavaScript properties 与 HTML attributes 时查阅属性与特性指南;处理 CSS、CSS 自定义属性或设计令牌时查阅样式指南;创建新 API 或确定父子组件 API 设计时查阅组件组合指南;处理用户提供内容或容器类组件时查阅插槽指南;创建新事件或监听已有事件时查阅自定义事件指南;创建新组件或将组件作为依赖使用时查阅组件注册指南;创建新组件或包时查阅打包与导出指南。

适用场景:前端组件库开发、Web Components 或类似组件体系的 API 设计评审与实现。

限制:资料未提供具体代码示例、安装命令、平台支持范围、收费信息或版本要求,暂未提供。